Javadoc

Author: garydgregory

src/main/java/org/apache/commons/beanutils/BaseDynaBeanMapDecorator.java

@@ -173,7 +173,7 @@ public boolean containsValue(final Object value) {
     /**
      * Converts the name of a property to the key type of this decorator.
      *
-     * @param propertyName the name of a property
+     * @param propertyName The name of a property
      * @return The converted key to be used in the decorated map
      */
     protected abstract K convertKey(String propertyName);

src/main/java/org/apache/commons/beanutils/BeanAccessLanguageException.java

@@ -38,7 +38,7 @@ public BeanAccessLanguageException() {
     /**
      * Constructs a {@code BeanAccessLanguageException} without a detail message.
      *
-     * @param message the detail message explaining this exception
+     * @param message The detail message explaining this exception
      */
     public BeanAccessLanguageException(final String message) {
         super(message);

src/main/java/org/apache/commons/beanutils/BeanComparator.java

@@ -209,8 +209,8 @@ public int hashCode() {
      * <em>Note</em>: This comparison cannot be performed in a type-safe way; so
      * {@code ClassCastException} exceptions may be thrown.
      *
-     * @param val1 the first value to be compared
-     * @param val2 the second value to be compared
+     * @param val1 The first value to be compared
+     * @param val2 The second value to be compared
      * @return The result of the comparison
      */
     private int internalCompare(final Object val1, final Object val2) {

src/main/java/org/apache/commons/beanutils/BeanIntrospectionData.java

@@ -49,7 +49,7 @@ class BeanIntrospectionData {
      * they may get lost when the GC claims soft references used by the
      * {@code PropertyDescriptor} objects.
      *
-     * @param descs the array with the descriptors of the available properties
+     * @param descs The array with the descriptors of the available properties
      * @return The map with the names of write methods for properties
      */
     private static Map<String, String> setUpWriteMethodNames(final PropertyDescriptor[] descs) {
@@ -73,7 +73,7 @@ private static Map<String, String> setUpWriteMethodNames(final PropertyDescripto
      * Creates a new instance of {@code BeanIntrospectionData} and initializes its
      * completely.
      *
-     * @param descs the array with the descriptors of the available properties
+     * @param descs The array with the descriptors of the available properties
      */
     public BeanIntrospectionData(final PropertyDescriptor[] descs) {
         this(descs, setUpWriteMethodNames(descs));
@@ -83,8 +83,8 @@ public BeanIntrospectionData(final PropertyDescriptor[] descs) {
      * Creates a new instance of {@code BeanIntrospectionData} and allows setting the map
      * with write method names. This constructor is mainly used for testing purposes.
      *
-     * @param descs the array with the descriptors of the available properties
-     * @param writeMethNames the map with the names of write methods
+     * @param descs The array with the descriptors of the available properties
+     * @param writeMethNames The map with the names of write methods
      */
     BeanIntrospectionData(final PropertyDescriptor[] descs, final Map<String, String> writeMethNames) {
         descriptors = descs;
@@ -95,7 +95,7 @@ public BeanIntrospectionData(final PropertyDescriptor[] descs) {
      * Returns the {@code PropertyDescriptor} for the property with the specified name. If
      * this property is unknown, result is {@code null}.
      *
-     * @param name the name of the property in question
+     * @param name The name of the property in question
      * @return The {@code PropertyDescriptor} for this property or {@code null}
      */
     public PropertyDescriptor getDescriptor(final String name) {
@@ -125,8 +125,8 @@ public PropertyDescriptor[] getDescriptors() {
      * additional information stored in this object is necessary to obtain the method
      * again.
      *
-     * @param beanCls the class of the affected bean
-     * @param desc the {@code PropertyDescriptor} of the desired property
+     * @param beanCls The class of the affected bean
+     * @param desc The {@code PropertyDescriptor} of the desired property
      * @return The write method for this property or {@code null} if there is none
      */
     public Method getWriteMethod(final Class<?> beanCls, final PropertyDescriptor desc) {

src/main/java/org/apache/commons/beanutils/BeanIntrospector.java

@@ -44,7 +44,7 @@ public interface BeanIntrospector {
      * properties according to the rules it implements, and add them to the
      * passed in context object.
      *
-     * @param icontext the context object for interaction with the initiator of
+     * @param icontext The context object for interaction with the initiator of
      *        the introspection request
      * @throws IntrospectionException if an error occurs during introspection
      */

src/main/java/org/apache/commons/beanutils/BeanMap.java

@@ -53,9 +53,9 @@ protected static class Entry extends AbstractMapEntry {
         /**
          * Constructs a new {@code Entry}.
          *
-         * @param owner the BeanMap this entry belongs to
-         * @param key   the key for this entry
-         * @param value the value for this entry
+         * @param owner The BeanMap this entry belongs to
+         * @param key   The key for this entry
+         * @param value The value for this entry
          */
         protected Entry(final BeanMap owner, final Object key, final Object value) {
             super(key, value);
@@ -65,7 +65,7 @@ protected Entry(final BeanMap owner, final Object key, final Object value) {
         /**
          * Sets the value.
          *
-         * @param value the new value for the entry
+         * @param value The new value for the entry
          * @return The old value for the entry
          */
         @Override
@@ -197,7 +197,7 @@ public BeanMap() {
     /**
      * Constructs a new {@code BeanMap} that operates on the specified bean. If the given bean is {@code null}, then this map will be empty.
      *
-     * @param bean the bean for this map to operate on
+     * @param bean The bean for this map to operate on
      */
     public BeanMap(final Object bean) {
         this.bean = bean;
@@ -287,7 +287,7 @@ public Object clone() throws CloneNotSupportedException {
      * <p>
      * Write-only properties will not be matched as the test operates against property read methods.
      *
-     * @param name the name of the property to check
+     * @param name The name of the property to check
      * @return false if the given name is null or is not a {@code String}; false if the bean does not define a property with that name; or true if the bean
      *         does define a property with that name
      */
@@ -300,7 +300,7 @@ public boolean containsKey(final Object name) {
     /**
      * Returns true if the bean defines a property whose current value is the given object.
      *
-     * @param value the value to check
+     * @param value The value to check
      * @return false true if the bean has at least one property whose current value is that object, false otherwise
      */
     @Override
@@ -322,8 +322,8 @@ public boolean containsValue(final Object value) {
      * If no special constructor exists and the given type is not a primitive type, this method returns the original value.
      * </p>
      *
-     * @param newType the type to convert the value to
-     * @param value   the value to convert
+     * @param newType The type to convert the value to
+     * @param value   The value to convert
      * @return The converted value
      * @throws NumberFormatException     if newType is a primitive type, and the string representation of the given value cannot be converted to that type
      * @throws InstantiationException    if the constructor found with reflection raises it
@@ -354,8 +354,8 @@ protected Object convertType(final Class<?> newType, final Object value)
      * Creates an array of parameters to pass to the given mutator method. If the given object is not the right type to pass to the method directly, it will be
      * converted using {@link #convertType(Class,Object)}.
      *
-     * @param method the mutator method
-     * @param value  the value to pass to the mutator method
+     * @param method The mutator method
+     * @param value  The value to pass to the mutator method
      * @return An array containing one object that is either the given value or a transformed value
      * @throws IllegalAccessException   if {@link #convertType(Class,Object)} raises it
      * @throws IllegalArgumentException if any other exception is raised by {@link #convertType(Class,Object)}
@@ -436,9 +436,9 @@ public int size() {
      * Called during a successful {@link #put(Object,Object)} operation. Default implementation does nothing. Override to be notified of property changes in the
      * bean caused by this map.
      *
-     * @param key      the name of the property that changed
-     * @param oldValue the old value for that property
-     * @param newValue the new value for that property
+     * @param key      The name of the property that changed
+     * @param oldValue The old value for that property
+     * @param newValue The new value for that property
      */
     protected void firePropertyChange(final Object key, final Object oldValue, final Object newValue) {
     }
@@ -451,7 +451,7 @@ protected void firePropertyChange(final Object key, final Object oldValue, final
      * <p>
      * Write-only properties will not be matched as the test operates against property read methods.
      *
-     * @param name the name of the property whose value to return
+     * @param name The name of the property whose value to return
      * @return The value of the property with that name
      */
     @Override
@@ -483,7 +483,7 @@ public Object getBean() {
     /**
      * Returns the accessor for the property with the given name.
      *
-     * @param name the name of the property
+     * @param name The name of the property
      * @return null if the name is null; null if the name is not a {@link String}; null if no such property exists; or the accessor method for that property
      */
     protected Method getReadMethod(final Object name) {
@@ -493,7 +493,7 @@ protected Method getReadMethod(final Object name) {
     /**
      * Returns the accessor for the property with the given name.
      *
-     * @param name the name of the property
+     * @param name The name of the property
      * @return The accessor method for the property, or null
      */
     public Method getReadMethod(final String name) {
@@ -503,7 +503,7 @@ public Method getReadMethod(final String name) {
     /**
      * Returns the type of the property with the given name.
      *
-     * @param name the name of the property
+     * @param name The name of the property
      * @return The type of the property, or {@code null} if no such property exists
      */
     public Class<?> getType(final String name) {
@@ -513,7 +513,7 @@ public Class<?> getType(final String name) {
     /**
      * Returns a transformer for the given primitive type.
      *
-     * @param aType the primitive type whose transformer to return
+     * @param aType The primitive type whose transformer to return
      * @return A transformer that will convert strings into that type, or null if the given type is not a primitive type
      */
     protected Transformer getTypeTransformer(final Class<?> aType) {
@@ -525,7 +525,7 @@ protected Transformer getTypeTransformer(final Class<?> aType) {
     /**
      * Returns the mutator for the property with the given name.
      *
-     * @param name the name of the
+     * @param name The name of the
      * @return null if the name is null; null if the name is not a {@link String}; null if no such property exists; null if the property is read-only; or the
      *         mutator method for that property
      */
@@ -536,7 +536,7 @@ protected Method getWriteMethod(final Object name) {
     /**
      * Returns the mutator for the property with the given name.
      *
-     * @param name the name of the property
+     * @param name The name of the property
      * @return The mutator method for the property, or null
      */
     public Method getWriteMethod(final String name) {
@@ -608,7 +608,7 @@ public Set<Object> keySet() {
     /**
      * Logs the given exception to {@code System.out}. Used to display warnings while accessing/mutating the bean.
      *
-     * @param ex the exception to log
+     * @param ex The exception to log
      */
     protected void logInfo(final Exception ex) {
         // Deliberately do not use LOG4J or Commons Logging to avoid dependencies
@@ -618,7 +618,7 @@ protected void logInfo(final Exception ex) {
     /**
      * Logs the given exception to {@code System.err}. Used to display errors while accessing/mutating the bean.
      *
-     * @param ex the exception to log
+     * @param ex The exception to log
      */
     protected void logWarn(final Exception ex) {
         // Deliberately do not use LOG4J or Commons Logging to avoid dependencies
@@ -629,8 +629,8 @@ protected void logWarn(final Exception ex) {
     /**
      * Sets the bean property with the given name to the given value.
      *
-     * @param name  the name of the property to set
-     * @param value the value to set that property to
+     * @param name  The name of the property to set
+     * @param value The value to set that property to
      * @return The previous value of that property
      * @throws IllegalArgumentException if the given name is null; if the given name is not a {@link String}; if the bean doesn't define a property with that
      *                                  name; or if the bean property with that name is read-only
@@ -661,7 +661,7 @@ public Object put(final Object name, final Object value) throws IllegalArgumentE
     /**
      * Puts all of the writable properties from the given BeanMap into this BeanMap. Read-only and Write-only properties will be ignored.
      *
-     * @param map the BeanMap whose properties to put
+     * @param map The BeanMap whose properties to put
      */
     public void putAllWriteable(final BeanMap map) {
         for (final Object key : map.readMethods.keySet()) {
@@ -686,7 +686,7 @@ protected void reinitialise() {
     /**
      * Sets the bean to be operated on by this map. The given value may be null, in which case this map will be empty.
      *
-     * @param newBean the new bean to operate on
+     * @param newBean The new bean to operate on
      */
     public void setBean(final Object newBean) {
         bean = newBean;

src/main/java/org/apache/commons/beanutils/BeanPredicate.java

@@ -43,9 +43,9 @@ public class BeanPredicate implements Predicate {
      * Constructs a {@code BeanPredicate} that applies the given
      * {@code Predicate} to the named property value.
      *
-     * @param propertyName the name of the property whose value is to be predicated,
+     * @param propertyName The name of the property whose value is to be predicated,
      * not null
-     * @param predicate the {@code Predicate} to be applied,
+     * @param predicate The {@code Predicate} to be applied,
      * not null
      */
     public BeanPredicate(final String propertyName, final Predicate predicate) {
@@ -123,7 +123,7 @@ public void setPredicate(final Predicate predicate) {
     /**
      * Sets the name of the property whose value is to be predicated.
      *
-     * @param propertyName the name of the property whose value is to be predicated,
+     * @param propertyName The name of the property whose value is to be predicated,
      * not null
      */
     public void setPropertyName(final String propertyName) {

src/main/java/org/apache/commons/beanutils/BeanUtilsBean.java

@@ -60,8 +60,8 @@ protected BeanUtilsBean initialValue() {
      * Determines the type of a {@code DynaProperty}. Here a special treatment
      * is needed for mapped properties.
      *
-     * @param dynaProperty the property descriptor
-     * @param value the value object to be set for this property
+     * @param dynaProperty The property descriptor
+     * @param value The value object to be set for this property
      * @return The type of this property
      */
     private static Class<?> dynaPropertyType(final DynaProperty dynaProperty,
@@ -198,8 +198,8 @@ protected Object convert(final Object value, final Class<?> type) {
      * bean. This method delegates to {@link #convert(Object, Class)}, but {@code null}
      * values are not converted. This causes {@code null} values to be copied verbatim.
      *
-     * @param value the value to be converted and copied
-     * @param type the target type of the conversion
+     * @param value The value to be converted and copied
+     * @param type The target type of the conversion
      * @return The converted value
      */
     private Object convertForCopy(final Object value, final Class<?> type) {