Revision: 814
http://stripes.svn.sourceforge.net/stripes/?rev=814&view=rev
Author: javelotinfo
Date: 2008-01-29 06:08:37 -0800 (Tue, 29 Jan 2008)
Log Message:
-----------
Minor Javadoc corrections.
Modified Paths:
--------------
trunk/stripes/src/net/sourceforge/stripes/action/ActionBean.java
trunk/stripes/src/net/sourceforge/stripes/action/ActionBeanContext.java
trunk/stripes/src/net/sourceforge/stripes/action/ErrorResolution.java
trunk/stripes/src/net/sourceforge/stripes/action/FileBean.java
trunk/stripes/src/net/sourceforge/stripes/action/LocalizableMessage.java
trunk/stripes/src/net/sourceforge/stripes/action/SimpleMessage.java
trunk/stripes/src/net/sourceforge/stripes/action/StreamingResolution.java
trunk/stripes/src/net/sourceforge/stripes/controller/ActionResolver.java
trunk/stripes/src/net/sourceforge/stripes/controller/AnnotatedClassActionResolver.java
trunk/stripes/src/net/sourceforge/stripes/controller/BeforeAfterMethodInterceptor.java
trunk/stripes/src/net/sourceforge/stripes/controller/DefaultActionBeanPropertyBinder.java
trunk/stripes/src/net/sourceforge/stripes/controller/ExecutionContext.java
trunk/stripes/src/net/sourceforge/stripes/controller/FileUploadLimitExceededException.java
trunk/stripes/src/net/sourceforge/stripes/controller/FlashScope.java
trunk/stripes/src/net/sourceforge/stripes/controller/Interceptor.java
trunk/stripes/src/net/sourceforge/stripes/controller/LifecycleStage.java
trunk/stripes/src/net/sourceforge/stripes/controller/NameBasedActionResolver.java
trunk/stripes/src/net/sourceforge/stripes/controller/StripesConstants.java
Modified: trunk/stripes/src/net/sourceforge/stripes/action/ActionBean.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/action/ActionBean.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/action/ActionBean.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -63,7 +63,7 @@
* case that Stripes cannot figure out a specific handler method to invoke.
This occurs most often
* when a form is submitted by the user hitting the enter/return key, and so
no form button is
* activated. Essentially the default handler is specifying the default
operation for your form.
- * In forms that have only one handler method, that method should alsways be
declared as the
+ * In forms that have only one handler method, that method should always be
declared as the
* default. For example:</p>
*
* <pre>
Modified:
trunk/stripes/src/net/sourceforge/stripes/action/ActionBeanContext.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/action/ActionBeanContext.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/action/ActionBeanContext.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -54,7 +54,7 @@
private ValidationErrors validationErrors;
/**
- * Retreives the HttpServletRequest object that is associated with the
current request.
+ * Retrieves the HttpServletRequest object that is associated with the
current request.
* @return HttpServletRequest the current request
*/
public HttpServletRequest getRequest() {
Modified: trunk/stripes/src/net/sourceforge/stripes/action/ErrorResolution.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/action/ErrorResolution.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/action/ErrorResolution.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -56,18 +56,22 @@
response.sendError(errorCode);
}
+ /** Accessor for the HTTP status code. */
public int getErrorCode() {
return errorCode;
}
+ /** Setter for the HTTP status code. */
public void setErrorCode(int errorCode) {
this.errorCode = errorCode;
}
+ /** Accessor for the descriptive error message. */
public String getErrorMessage() {
return errorMessage;
}
+ /** Setter for the descriptive error message. */
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
Modified: trunk/stripes/src/net/sourceforge/stripes/action/FileBean.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/action/FileBean.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/action/FileBean.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -18,7 +18,7 @@
/**
* <p>Represents a file that was submitted as part of an HTTP POST request.
Provides methods for
- * examining information about the file, and the retreiving the contents of
the file. When a file
+ * examining information about the file, and the retrieving the contents of
the file. When a file
* is uploaded by a user it is stored as a temporary file on the file system,
which is wrapped by an
* instance of this class. This is necessary because browsers may send file
upload segments before
* sending any other form parameters needed to identify what to do with the
uploaded files!</p>
Modified:
trunk/stripes/src/net/sourceforge/stripes/action/LocalizableMessage.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/action/LocalizableMessage.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/action/LocalizableMessage.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -22,7 +22,7 @@
/**
* A non-error message class that can localize (or at least externalize) the
message String
* in a resource bundle. The bundle used is the Stripes error message bundle,
which can be
- * conifgured but by default is called 'StripesResources.properties'. In all
other ways
+ * configured but by default is called 'StripesResources.properties'. In all
other ways
* this class behaves like it's parent [EMAIL PROTECTED] SimpleMessage}.
*
* @author Tim Fennell
Modified: trunk/stripes/src/net/sourceforge/stripes/action/SimpleMessage.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/action/SimpleMessage.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/action/SimpleMessage.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -149,7 +149,7 @@
return true;
}
- /** Generated hashcode method. */
+ /** Generated hash code method. */
@Override
public int hashCode() {
return (message != null ? message.hashCode() : 0);
Modified:
trunk/stripes/src/net/sourceforge/stripes/action/StreamingResolution.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/action/StreamingResolution.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/action/StreamingResolution.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -45,7 +45,7 @@
* // custom output generation code
* response.getWriter.write(...);
* // or
- * reponse.getOutputStream.write(...);
+ * response.getOutputStream.write(...);
* }
*}.setFilename("your-filename.xml");
*</pre>
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/ActionResolver.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/controller/ActionResolver.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/controller/ActionResolver.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -27,7 +27,7 @@
* responsible for identifying the individual method on the ActionBean class
that should handle
* this specific request.</p>
*
- * <p>Throughout this class two terms are used that refer to similar but not
interchangable
+ * <p>Throughout this class two terms are used that refer to similar but not
interchangeable
* concepts. [EMAIL PROTECTED] UrlBinding} refers to the exact URL to which a
bean is bound, e.g.
* [EMAIL PROTECTED] /account/Profile.action}. [EMAIL PROTECTED] Path} refers
to the path segment of the requested
* URL and is generally composed of the URL binding and possibly some
additional information,
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/AnnotatedClassActionResolver.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/controller/AnnotatedClassActionResolver.java
2008-01-29 04:12:00 UTC (rev 813)
+++
trunk/stripes/src/net/sourceforge/stripes/controller/AnnotatedClassActionResolver.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -389,7 +389,7 @@
* <p>Searched for a parameter in the request whose name matches one of
the named events handled
* by the ActionBean. For example, if the ActionBean can handle events
foo and bar, this
* method will scan the request for foo=somevalue and bar=somevalue. If
it find a request
- * paremeter with a matching name it will return that name. If there are
multiple matching
+ * parameter with a matching name it will return that name. If there are
multiple matching
* names, the result of this method cannot be guaranteed.</p>
*
* <p>If the event name cannot be determined through the parameter names,
two alternative
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/BeforeAfterMethodInterceptor.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/controller/BeforeAfterMethodInterceptor.java
2008-01-29 04:12:00 UTC (rev 813)
+++
trunk/stripes/src/net/sourceforge/stripes/controller/BeforeAfterMethodInterceptor.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -74,7 +74,7 @@
new ConcurrentHashMap<Class<? extends ActionBean>,
FilterMethods>();
/**
- * Does the main work of the interceptor as decsribed in the class level
javadoc.
+ * Does the main work of the interceptor as described in the class level
javadoc.
* Executed the before and after methods for the ActionBean as appropriate
for the
* current lifecycle stage. Lazily examines the ActionBean to determine
the set
* of methods to execute, if it has not yet been examined.
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/DefaultActionBeanPropertyBinder.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/controller/DefaultActionBeanPropertyBinder.java
2008-01-29 04:12:00 UTC (rev 813)
+++
trunk/stripes/src/net/sourceforge/stripes/controller/DefaultActionBeanPropertyBinder.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -689,9 +689,9 @@
*
* <p>
* Only parameter values that are non-null and do not equal the empty
String will be converted
- * and returned. So an input array with one entry equalling the empty
string, [""], will result
+ * and returned. So an input array with one entry equaling the empty
string, [""], will result
* in an <b>empty</b> List being returned. Similarly, if a length three
array is passed in with
- * one item equalling the empty String, a List of length two will be
returned.
+ * one item equaling the empty String, a List of length two will be
returned.
* </p>
*
* @param bean the ActionBean on which the property to convert exists
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/ExecutionContext.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/controller/ExecutionContext.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/controller/ExecutionContext.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -75,7 +75,7 @@
}
/**
- * Retreives the ActionBeanContext associated with the current request.
Available to all
+ * Retrieves the ActionBeanContext associated with the current request.
Available to all
* interceptors regardless of [EMAIL PROTECTED] LifecycleStage}.
*
* @return the current ActionBeanContext
@@ -101,7 +101,7 @@
public void setActionBean(ActionBean actionBean) { this.actionBean =
actionBean; }
/**
- * Retrieves the handler Method that is targetted by the current request.
Available
+ * Retrieves the handler Method that is targeted by the current request.
Available
* to interceptors only after [EMAIL PROTECTED]
LifecycleStage#HandlerResolution} has occurred.
*
* @return the current ActionBean instance, or null if not yet resolved
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/FileUploadLimitExceededException.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/controller/FileUploadLimitExceededException.java
2008-01-29 04:12:00 UTC (rev 813)
+++
trunk/stripes/src/net/sourceforge/stripes/controller/FileUploadLimitExceededException.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -29,7 +29,7 @@
private long posted;
/**
- * Constructs a new exception that contains the limt that was violated,
and the size
+ * Constructs a new exception that contains the limit that was violated,
and the size
* of the post that violated it, both in bytes.
*
* @param max the current post size limit
Modified: trunk/stripes/src/net/sourceforge/stripes/controller/FlashScope.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/controller/FlashScope.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/controller/FlashScope.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -70,7 +70,7 @@
* <p>To ensure that orphaned FlashScopes do not consume increasing amounts of
HttpSession memory,
* the StripesFilter, after each request, checks to see if any FlashScopes
have recently expired.
* A FlashScope is expired when the length of time from the end of the request
that created the
- * FlashScope is greater than the timout set on the FlashScope. The default
timeout is 120 seconds
+ * FlashScope is greater than the timeout set on the FlashScope. The default
timeout is 120 seconds
* (or two minutes), and can be varied by calling [EMAIL PROTECTED]
#setTimeout(int)} Since the timer
* starts when a request completes, and FlashScopes are only meant to live
from the end of one
* request to the beginning of a subsequent request this value is set quite
low.</p>
@@ -111,7 +111,7 @@
public void setTimeout(int timeout) { this.timeout = timeout; }
/**
- * Returns the key used to store this flash scope in the colleciton of
flash scopes.
+ * Returns the key used to store this flash scope in the collection of
flash scopes.
*/
public Integer key() {
return key;
@@ -174,7 +174,7 @@
}
/**
- * Returns true if the flash scope has expired and should be de-referenced
to allow
+ * Returns true if the flash scope has expired and should be dereferenced
to allow
* garbage collection. Returns false if the flash scope should be retained.
*
* @return true if the flash scope has expired, false otherwise
@@ -308,7 +308,7 @@
}
/**
- * Internal helper method to retreive (and selectively create) the
container for all
+ * Internal helper method to retrieve (and selectively create) the
container for all
* the flash scopes. Will return null if the container does not exist and
<i>create</i> is
* false. Will also return null if the current session has been
invalidated, regardless
* of the value of <i>create</i>.
Modified: trunk/stripes/src/net/sourceforge/stripes/controller/Interceptor.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/controller/Interceptor.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/controller/Interceptor.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -69,7 +69,7 @@
* [EMAIL PROTECTED] net.sourceforge.stripes.config.Configuration}. To
configure interceptors you can either
* implement your own Configuration (probably by subclassing
* [EMAIL PROTECTED] net.sourceforge.stripes.config.RuntimeConfiguration}), or
more likely by listing out
- * the interceptors desired in the web.xml as specified in the documenation for
+ * the interceptors desired in the web.xml as specified in the documentation
for
* [EMAIL PROTECTED]
net.sourceforge.stripes.config.RuntimeConfiguration#initInterceptors()}.</p>
*
* @author Tim Fennell
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/LifecycleStage.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/controller/LifecycleStage.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/controller/LifecycleStage.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -37,7 +37,7 @@
HandlerResolution,
/**
- * Third major lifecycle stage. Involves the processing of all validations
specied through
+ * Third major lifecycle stage. Involves the processing of all validations
specified through
* [EMAIL PROTECTED] @Validate annotations as well as the type conversion
of request parameters
* and their binding to the ActionBean.
*/
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/NameBasedActionResolver.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/controller/NameBasedActionResolver.java
2008-01-29 04:12:00 UTC (rev 813)
+++
trunk/stripes/src/net/sourceforge/stripes/controller/NameBasedActionResolver.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -51,7 +51,7 @@
* giving the binding [EMAIL PROTECTED] /foo/Bar.action}.</p>
*
* <p>The translation of class names into URL bindings is designed to be easy
to override and
- * customize. To that end you can easiliy change how this translation is done
by overriding
+ * customize. To that end you can easily change how this translation is done
by overriding
* [EMAIL PROTECTED] getBasePackages()} and/or [EMAIL PROTECTED]
getBindingSuffix()}, or completely customize the
* behaviour by overriding [EMAIL PROTECTED] getUrlBinding(String)}.</p>
*
@@ -70,7 +70,7 @@
* [EMAIL PROTECTED] #handleActionBeanNotFound(ActionBeanContext, String)} or
[EMAIL PROTECTED] #findView(String)}. The
* default behaviour is to map the URL being requested to three potential JSP
names/paths, check
* for the existence of a JSP at those locations and if one exists then to
return an ActionBean
- * that will render the view. For example if a user requsted
'/account/ViewAccount.action' but
+ * that will render the view. For example if a user requested
'/account/ViewAccount.action' but
* an ActionBean does not yet exist bound to that URL, the resolver will check
for JSPs in the
* following order:</p>
*
@@ -121,7 +121,7 @@
* class to see if an annotated url binding is present. If not, the class
name is taken
* and translated into a URL binding using [EMAIL PROTECTED]
getUrlBinding(String name)}.</p>
*
- * @param clazz a Class represenging an ActionBean
+ * @param clazz a Class representing an ActionBean
* @return the String URL binding for the ActionBean
*/
@Override
@@ -302,7 +302,7 @@
* <p>Can be overridden to look for views with a different pattern, or to
provide a different
* kind of resolution. It is strongly recommended when overriding this
method to check for
* the actual existence of views prior to manufacturing a resolution in
order not to cause
- * confusion when URLs are mis-typed.</p>
+ * confusion when URLs are mistyped.</p>
*
* @param urlBinding the url being accessed by the client in the current
request
* @return a Resolution if a default view can be found, or null otherwise
Modified:
trunk/stripes/src/net/sourceforge/stripes/controller/StripesConstants.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/controller/StripesConstants.java
2008-01-29 04:12:00 UTC (rev 813)
+++ trunk/stripes/src/net/sourceforge/stripes/controller/StripesConstants.java
2008-01-29 14:08:37 UTC (rev 814)
@@ -86,7 +86,7 @@
/**
* The name of a request parameter that holds a Map of flash scopes keyed
by the
- * hashcode of the request that generated them.
+ * hash code of the request that generated them.
*/
String REQ_ATTR_FLASH_SCOPE_LOCATION = "__flash_scopes";
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Stripes-development mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/stripes-development
