Revision: 822
http://stripes.svn.sourceforge.net/stripes/?rev=822&view=rev
Author: javelotinfo
Date: 2008-01-31 13:02:59 -0800 (Thu, 31 Jan 2008)
Log Message:
-----------
Minor Javadoc corrections.
Modified Paths:
--------------
trunk/stripes/src/net/sourceforge/stripes/util/CollectionUtil.java
trunk/stripes/src/net/sourceforge/stripes/util/CryptoUtil.java
trunk/stripes/src/net/sourceforge/stripes/util/ReflectUtil.java
trunk/stripes/src/net/sourceforge/stripes/util/UrlBuilder.java
trunk/stripes/src/net/sourceforge/stripes/util/bean/BeanUtil.java
trunk/stripes/src/net/sourceforge/stripes/util/bean/JavaBeanPropertyAccessor.java
trunk/stripes/src/net/sourceforge/stripes/util/bean/Node.java
trunk/stripes/src/net/sourceforge/stripes/util/bean/ParseException.java
trunk/stripes/src/net/sourceforge/stripes/util/bean/PropertyExpressionEvaluation.java
trunk/stripes/src/net/sourceforge/stripes/validation/BooleanTypeConverter.java
trunk/stripes/src/net/sourceforge/stripes/validation/DateTypeConverter.java
trunk/stripes/src/net/sourceforge/stripes/validation/SimpleError.java
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrorHandler.java
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrors.java
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationMethod.java
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationState.java
trunk/stripes/src/net/sourceforge/stripes/validation/expression/ExpressionValidator.java
Modified: trunk/stripes/src/net/sourceforge/stripes/util/CollectionUtil.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/util/CollectionUtil.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/util/CollectionUtil.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -142,7 +142,7 @@
/**
* Converts an Iterable into a List that can be navigated in ways other
than simple
* iteration. If the underlying implementation of the Iterable is a List,
it is cast
- * to List and returned. Othewise it is iterated and the items placed, in
order,
+ * to List and returned. Otherwise it is iterated and the items placed, in
order,
* into a new List.
*
* @param in an Iterable to serve as the source for a List
Modified: trunk/stripes/src/net/sourceforge/stripes/util/CryptoUtil.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/util/CryptoUtil.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/util/CryptoUtil.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -53,7 +53,7 @@
* <p>Two additional measures are taken to improve security. Firstly a nonce
value is prepended
* to the input during encryption. This is a value generated each time using
a SecureRandom.
* Doing this ensures that the same value is not encrypted the same way each
time and leads to
- * increased unpredictabibilty of the encrypted values. Secondly a "magic
number" is also
+ * increased unpredictability of the encrypted values. Secondly a "magic
number" is also
* prepended to the input (after the nonce). The magic number is verified at
decryption time
* to ensure that the value passed in was encrypted using the same key as was
used for decryption.</p>
*
Modified: trunk/stripes/src/net/sourceforge/stripes/util/ReflectUtil.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/util/ReflectUtil.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/util/ReflectUtil.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -230,7 +230,7 @@
/**
* Fetches all methods of all access types from the supplied class and
super
- * classes. Methods that have been overridden in the inheritance hierachy
are
+ * classes. Methods that have been overridden in the inheritance hierarchy
are
* only returned once, using the instance lowest down the hierarchy.
*
* @param clazz the class to inspect
@@ -261,7 +261,7 @@
/**
* Fetches all fields of all access types from the supplied class and super
- * classes. Fieldss that have been overridden in the inheritance hierachy
are
+ * classes. Fieldss that have been overridden in the inheritance hierarchy
are
* only returned once, using the instance lowest down the hierarchy.
*
* @param clazz the class to inspect
@@ -327,7 +327,7 @@
* <p>Checks the method passed in and if it already meets these criteria
it is returned
* immediately. In general this leads to very little performance
overhead</p>
*
- * <p>If the method does not meet the critieria then the class' interfaces
are scanned
+ * <p>If the method does not meet the criteria then the class' interfaces
are scanned
* for a matching method. If one is not found, then the class' superclass
hierarchy
* is searched. Finally, if no matching method can be found the original
method is
* returned.</p>
Modified: trunk/stripes/src/net/sourceforge/stripes/util/UrlBuilder.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/util/UrlBuilder.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/util/UrlBuilder.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -271,7 +271,7 @@
/**
* Sets the anchor, if any, that will be appended to the URL. E.g. if
supplied with
* 'input' then the URL will be terminated with '#input' in order to
instruct
- * the browser to navigate to the HTML anchor callled 'input' when
accessing the URL.
+ * the browser to navigate to the HTML anchor called 'input' when
accessing the URL.
*
* @param anchor the anchor with or without the leading pound sign, or
null to disable
*/
Modified: trunk/stripes/src/net/sourceforge/stripes/util/bean/BeanUtil.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/util/bean/BeanUtil.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/util/bean/BeanUtil.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -80,7 +80,7 @@
}
/**
- * Attempts to set the property to null or an equivelant value. In most
cases this leads
+ * Attempts to set the property to null or an equivalent value. In most
cases this leads
* to the property being set to null, but in the case of primitives the
default value is
* used and in the case of Maps the key is removed from the Map.
*
Modified:
trunk/stripes/src/net/sourceforge/stripes/util/bean/JavaBeanPropertyAccessor.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/util/bean/JavaBeanPropertyAccessor.java
2008-01-31 14:13:13 UTC (rev 821)
+++
trunk/stripes/src/net/sourceforge/stripes/util/bean/JavaBeanPropertyAccessor.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -22,7 +22,7 @@
/**
* Implementation of [EMAIL PROTECTED] PropertyAccessor} for reading JavaBean
properties from
- * JavaBeans. Will attempt property acccess first using the standard
PropertyDescriptor,
+ * JavaBeans. Will attempt property access first using the standard
PropertyDescriptor,
* but if no PropertyDescriptor is present then falls back to attempting Field
access for
* public fields.
*
Modified: trunk/stripes/src/net/sourceforge/stripes/util/bean/Node.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/util/bean/Node.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/util/bean/Node.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -62,7 +62,7 @@
/** Sets the next node in the expression. */
protected void setNext(Node next) { this.next = next; }
- /** Gets the prevoius node in the expression. Returns null if this is the
first node. */
+ /** Gets the previous node in the expression. Returns null if this is the
first node. */
public Node getPrevious() { return previous; }
/** Sets the previous node in the expression. */
Modified:
trunk/stripes/src/net/sourceforge/stripes/util/bean/ParseException.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/util/bean/ParseException.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/util/bean/ParseException.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -17,7 +17,7 @@
/**
* Exception used to designate that an expression was invalid and could not be
parsed. The
* exception will contain the offending expression (accessible via
getExpression()) as well
- * as a String message explaining why it was not parsable.
+ * as a String message explaining why it was not parseable.
*
* @author Tim Fennell
* @since Stripes 1.4
Modified:
trunk/stripes/src/net/sourceforge/stripes/util/bean/PropertyExpressionEvaluation.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/util/bean/PropertyExpressionEvaluation.java
2008-01-31 14:13:13 UTC (rev 821)
+++
trunk/stripes/src/net/sourceforge/stripes/util/bean/PropertyExpressionEvaluation.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -257,7 +257,7 @@
return m.getDeclaringClass().getMethod(m.getName());
}
}
- catch (Exception e) { /* Supress. */ }
+ catch (Exception e) { /* Suppress. */ }
return m;
}
@@ -271,7 +271,7 @@
* <p>After this method executes either 1) all necessary type information
will be set on the
* node and the appropriate type object returned or 2) an exception will
be thrown.</p>
*
- * @param end the node to instantate up to and determine the type of
+ * @param end the node to instantiate up to and determine the type of
* @return the Type of the node if possible
* @throws NoSuchPropertyException if the previous node is a JavaBean
(i.e. non-collection)
* node and does not contain a property with the corresponding name
@@ -479,7 +479,7 @@
* from subclass to superclass, but the mapping of TypeVariables to Types
has to start
* from the place were the type variable was originally defined
(superclass) and map
* to the place where the type is bound to an actual class (subclass). We
therefore
- * need to build up the mapings sub to super and then traverse super to sub.
+ * need to build up the mappings sub to super and then traverse super to
sub.
*
* @param paramType parameterized type to add to the map.
*/
@@ -572,7 +572,7 @@
}
/**
- * <p>Fetches the value of this expression evaluated against the bean.
This is equivelant
+ * <p>Fetches the value of this expression evaluated against the bean.
This is equivalent
* to calling the appropriate get() methods in sequence in order to fetch
the property
* indicated by the expression.</p>
*
@@ -592,7 +592,7 @@
}
/**
- * <p>Sets the value of the expression evaluated against the bean. This is
loosely equivelant
+ * <p>Sets the value of the expression evaluated against the bean. This is
loosely equivalent
* to calling the appropriate getter() on intermediate properties and then
calling the
* appropriate setter on the final sub-property.</p>
*
@@ -659,7 +659,7 @@
* <p>Sets the value of this expression to "null" for the bean. In
reality this is not always
* null, but the logical interpretation of "null" for a given type. For
primitives the
* value is set to be the default value for the primitive type as used by
the JVM when
- * initializing instance varibales. For Map entries the key is removed
from the Map instead
+ * initializing instance variables. For Map entries the key is removed
from the Map instead
* of leaving the key present with a null value.</p>
*
* <p>If any intermediate properties in the expression are null this
method will return
Modified:
trunk/stripes/src/net/sourceforge/stripes/validation/BooleanTypeConverter.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/validation/BooleanTypeConverter.java
2008-01-31 14:13:13 UTC (rev 821)
+++
trunk/stripes/src/net/sourceforge/stripes/validation/BooleanTypeConverter.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -19,8 +19,8 @@
import java.util.Locale;
/**
- * Performs a fairly aggressive conversion of a String to a boolean. The
String will be deemd to be
- * equivelant to true if it meets any of the following conditions:
+ * Performs a fairly aggressive conversion of a String to a boolean. The
String will be deemed to be
+ * equivalent to true if it meets any of the following conditions:
*
* <ul>
* <li>Equals, ignoring case, true</li>
@@ -74,7 +74,7 @@
long number = Long.parseLong(input);
retval = (number > 0);
}
- catch (NumberFormatException nfe) {/* Ingore the exception */ }
+ catch (NumberFormatException nfe) {/* Ignore the exception */ }
}
return retval;
Modified:
trunk/stripes/src/net/sourceforge/stripes/validation/DateTypeConverter.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/validation/DateTypeConverter.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/validation/DateTypeConverter.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -52,17 +52,17 @@
* <li>SHORT (e.g. 'M d yy' for Locale.US)</li>
* <li>MEDIUM (e.g. 'MMM d yyyy' for Locale.US)</li>
* <li>LONG (e.g. 'MMMM d yyyy' for Locale.US)</li>
- * <li>d MMM yy (note that for parsing MMM and MMMM are
interchangable)</li>
- * <li>yyyy M d (note that for parsing M and MM are interchangable)</li>
+ * <li>d MMM yy (note that for parsing MMM and MMMM are
interchangeable)</li>
+ * <li>yyyy M d (note that for parsing M and MM are interchangeable)</li>
* <li>yyyy MMM d</li>
* <li>EEE MMM dd HH:mm:ss zzz yyyy (the format created by
Date.toString())</li>
* </ul>
* </p>
*
* <p>This default set of formats can be changed by providing a different set
of format strings in
- * the Stripes resouce bundle, or by subclassing and overriding
getFormatStrings(). In all cases
+ * the Stripes resource bundle, or by subclassing and overriding
getFormatStrings(). In all cases
* patterns should be specified using single spaces as separators instead of
slashes, dashes
- * or other characaters.</p>
+ * or other characters.</p>
*
* <p>The regular expression pattern used in the pre-process method can also
be changed in the
* Stripes resource bundle, or by subclassing and overriding the
getPreProcessPattern() method.</p>
@@ -108,7 +108,7 @@
* white-space characters into a single space.</p>
*
* <p>This pattern can be changed by providing a different value under the
- * <code>'stripes.dateTypeConverter.preProcessPattern'</code> key in the
resouce
+ * <code>'stripes.dateTypeConverter.preProcessPattern'</code> key in the
resource
* bundle. The default value is <code>(?<!GMT)[\\s,-/\\.]+</code>.</p>
*/
public static final Pattern PRE_PROCESS_PATTERN =
Pattern.compile("(?<!GMT)[\\s,-/\\.]+");
@@ -183,7 +183,7 @@
Class<? extends Date> targetType,
Collection<ValidationError> errors) {
- // Step 1: pre process the input to make it more palatable
+ // Step 1: pre-process the input to make it more palatable
String parseable = preProcessInput(input);
// Step 2: try really hard to parse the input
@@ -240,8 +240,8 @@
* if there are only two parts it adds the current year to the end by
geting the
* Locale specific year string from a Calendar instance.
*
- * @param input the date string after the preprocess pattern has been run
against it
- * @return either the date string as is, or with the year appened to the
end
+ * @param input the date string after the pre-process pattern has been run
against it
+ * @return either the date string as is, or with the year appended to the
end
*/
protected String checkAndAppendYear(String input) {
// Count the spaces, date components = spaces + 1
Modified: trunk/stripes/src/net/sourceforge/stripes/validation/SimpleError.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/validation/SimpleError.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/validation/SimpleError.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -75,7 +75,7 @@
* Helper method that is used to widen the replacement parameter array to
make
* room for the two standard parameters, the field name and field value.
*
- * @param parameter zero or more replacement parmeters
+ * @param parameter zero or more replacement parameters
*/
static Object[] processReplacementParameters(Object... parameter) {
if (parameter == null) {
@@ -182,7 +182,7 @@
return true;
}
- /** Hashcode based on the message, field name key, action path and
parameters. */
+ /** Hash code based on the message, field name key, action path and
parameters. */
@Override
public int hashCode() {
int result = super.hashCode();
Modified:
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrorHandler.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrorHandler.java
2008-01-31 14:13:13 UTC (rev 821)
+++
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrorHandler.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -58,7 +58,7 @@
public interface ValidationErrorHandler {
/**
- * Allows the ActionBean to influence what happens when validaiton errors
occur during
+ * Allows the ActionBean to influence what happens when validation errors
occur during
* validation and binding. See class level javadoc for full description
of behaviour.
*
* @param errors the set of validation errors generated during validation
and binding
Modified:
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrors.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrors.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/validation/ValidationErrors.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -67,7 +67,7 @@
/**
- * Add multiple errors for a particular field. Does not destroy or
override any exisitng errors.
+ * Add multiple errors for a particular field. Does not destroy or
override any existing errors.
* Purely a convenience method to avoid having to check and possibly
instantiate the collection
* of errors for a field if it does not already exist.
*
@@ -82,7 +82,7 @@
/**
* Synonym for putAll(). Add multiple errors for a particular field. Does
not destroy or
- * override any exisitng errors.
+ * override any existing errors.
* Purely a convenience method to avoid having to check and possibly
instantiate the collection
* of errors for a field if it does not already exist.
*
Modified:
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationMethod.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/validation/ValidationMethod.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/validation/ValidationMethod.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -48,7 +48,7 @@
* events except those listed.</p>
*
* <p>The [EMAIL PROTECTED] when} attribute controls whether or not the
validation method is executed when
- * one or more validation errors exist. It has no affect when there are no
valiation errors.
+ * one or more validation errors exist. It has no affect when there are no
validation errors.
* A value of [EMAIL PROTECTED] ValidationState#ALWAYS} will cause the method
to be invoked even if errors
* exist. This is useful when you wish to perform additional validations that
do not depend
* on having a well-validated ActionBean since it allows the user to see more
validation errors
Modified:
trunk/stripes/src/net/sourceforge/stripes/validation/ValidationState.java
===================================================================
--- trunk/stripes/src/net/sourceforge/stripes/validation/ValidationState.java
2008-01-31 14:13:13 UTC (rev 821)
+++ trunk/stripes/src/net/sourceforge/stripes/validation/ValidationState.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -37,7 +37,7 @@
/**
* Specifies that the decision of whether or not the validation should be
applied when
* errors exist should be made by consulting the system level default.
Stripes' default
- * for the system level value is equivelant to NO_ERRORS, but can be
configured. See the
+ * for the system level value is equivalent to NO_ERRORS, but can be
configured. See the
* Stripes
* <a
href="http://stripesframework.org/confluence/display/stripes/Configuration+Reference#ConfigurationReference-ValidationProperties";>Configuration
Reference</a>
* for details.
Modified:
trunk/stripes/src/net/sourceforge/stripes/validation/expression/ExpressionValidator.java
===================================================================
---
trunk/stripes/src/net/sourceforge/stripes/validation/expression/ExpressionValidator.java
2008-01-31 14:13:13 UTC (rev 821)
+++
trunk/stripes/src/net/sourceforge/stripes/validation/expression/ExpressionValidator.java
2008-01-31 21:02:59 UTC (rev 822)
@@ -80,7 +80,7 @@
* Gets the executor that will be used to run expression evaluation. If
none is yet set
* the [EMAIL PROTECTED] #initialize()} method will be run to set one up.
*
- * @return an instance of ExpressionExecutor that can be used to execut
validation expressions
+ * @return an instance of ExpressionExecutor that can be used to execute
validation expressions
*/
public static ExpressionExecutor getExecutor() {
if (executor == null) initialize();
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
