Sort imports

Fix Javadoc warnings

Author: garydgregory

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

@@ -125,9 +125,9 @@ public BaseDynaBeanMapDecorator(final DynaBean dynaBean, final boolean readOnly)
 
 
     /**
-     * clear() operation is not supported.
+     * Always throws UnsupportedOperationException because this operation is unsupported.
      *
-     * @throws UnsupportedOperationException
+     * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public void clear() {
@@ -334,11 +334,11 @@ public void putAll(final Map<? extends K, ? extends Object> map) {
     }
 
     /**
-     * remove() operation is not supported.
+     * Always throws UnsupportedOperationException because this operation is unsupported.
      *
-     * @param key The {@link DynaBean}'s property name
-     * @return the value removed
-     * @throws UnsupportedOperationException
+     * @param key The {@link DynaBean}'s property name.
+     * @return the value removed.
+     * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public Object remove(final Object key) {

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

@@ -48,7 +48,16 @@
 public class BeanComparator<T> implements Comparator<T>, Serializable {
 
     private static final long serialVersionUID = 1L;
+    
+    /**
+     * Method name to call to compare.
+     */
     private String property;
+    
+    /**
+     * BeanComparator will pass the values of the specified bean property to this Comparator. If your bean property is not a comparable or contains null values,
+     * a suitable comparator may be supplied in this constructor.
+     */
     private final Comparator<?> comparator;
 
     /**
@@ -83,8 +92,8 @@ public BeanComparator() {
      * property. See {@link PropertyUtilsBean} for property query language syntax.
      * If the property passed in is null then the actual objects will be compared
      */
-    public BeanComparator( final String property ) {
-        this( property, ComparableComparator.getInstance() );
+    public BeanComparator(final String property) {
+        this(property, ComparableComparator.getInstance());
     }
 
     /**
@@ -103,8 +112,8 @@ public BeanComparator( final String property ) {
      * contains null values, a suitable comparator
      * may be supplied in this constructor.
      */
-    public BeanComparator( final String property, final Comparator<?> comparator ) {
-        setProperty( property );
+    public BeanComparator(final String property, final Comparator<?> comparator) {
+        setProperty(property);
         if (comparator != null) {
             this.comparator = comparator;
         } else {
@@ -121,30 +130,26 @@ public BeanComparator( final String property, final Comparator<?> comparator ) {
      * @return int negative or positive based on order
      */
     @Override
-    public int compare( final T o1, final T o2 ) {
+    public int compare(final T o1, final T o2) {
 
-        if ( property == null ) {
+        if (property == null) {
             // compare the actual objects
-            return internalCompare( o1, o2 );
+            return internalCompare(o1, o2);
         }
 
         try {
-            final Object value1 = PropertyUtils.getProperty( o1, property );
-            final Object value2 = PropertyUtils.getProperty( o2, property );
-            return internalCompare( value1, value2 );
-        }
-        catch ( final IllegalAccessException iae ) {
-            throw new RuntimeException( "IllegalAccessException: " + iae.toString() );
-        }
-        catch ( final InvocationTargetException ite ) {
-            throw new RuntimeException( "InvocationTargetException: " + ite.toString() );
-        }
-        catch ( final NoSuchMethodException nsme ) {
-            throw new RuntimeException( "NoSuchMethodException: " + nsme.toString() );
+            final Object value1 = PropertyUtils.getProperty(o1, property);
+            final Object value2 = PropertyUtils.getProperty(o2, property);
+            return internalCompare(value1, value2);
+        } catch (final IllegalAccessException iae) {
+            throw new RuntimeException("IllegalAccessException: " + iae.toString());
+        } catch (final InvocationTargetException ite) {
+            throw new RuntimeException("InvocationTargetException: " + ite.toString());
+        } catch (final NoSuchMethodException nsme) {
+            throw new RuntimeException("NoSuchMethodException: " + nsme.toString());
         }
     }
 
-
     /**
      * Two <code>BeanComparator</code>'s are equals if and only if
      * the wrapped comparators and the property names to be compared

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

@@ -263,32 +263,29 @@ private Class<?> readAnyClass(final ObjectInputStream in) throws IOException, Cl
 
 
     /**
-     * Reads field values for this object safely.
-     * There are issues with serializing primitive class types on certain JVM versions
-     * (including java 1.3).
-     * This method provides a workaround.
+     * Reads field values for this object safely. There are issues with serializing primitive class types on certain JVM versions (including java 1.3). This
+     * method provides a workaround.
      *
-     * @throws StreamCorruptedException when the stream data values are outside expected range
+     * @param in the content source.
+     * @throws IOException            when the stream data values are outside expected range
+     * @throws ClassNotFoundException Class of a serialized object cannot be found.
      */
     private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
-
         this.type = readAnyClass(in);
-
         if (isMapped() || isIndexed()) {
             this.contentType = readAnyClass(in);
         }
-
         // read other values
         in.defaultReadObject();
     }
 
     /**
      * Return a String representation of this Object.
+     *
      * @return a String representation of the dyna property
      */
     @Override
     public String toString() {
-
         final StringBuilder sb = new StringBuilder("DynaProperty[name=");
         sb.append(this.name);
         sb.append(",type=");
@@ -302,7 +299,9 @@ public String toString() {
     }
 
     /**
-     * Write a class using safe encoding to workaround java 1.3 serialization bug.
+     * Writes a class using safe encoding to workaround java 1.3 serialization bug.
+     *
+     * @throws IOException if I/O errors occur while writing to the underlying stream.
      */
     private void writeAnyClass(final Class<?> clazz, final ObjectOutputStream out) throws IOException {
         // safely write out any class
@@ -324,7 +323,6 @@ private void writeAnyClass(final Class<?> clazz, final ObjectOutputStream out) t
         } else if (Short.TYPE.equals(clazz)) {
             primitiveType = SHORT_TYPE;
         }
-
         if (primitiveType == 0) {
             // then it's not a primitive type
             out.writeBoolean(false);
@@ -338,19 +336,17 @@ private void writeAnyClass(final Class<?> clazz, final ObjectOutputStream out) t
 
 
     /**
-     * Writes this object safely.
-     * There are issues with serializing primitive class types on certain JVM versions
-     * (including java 1.3).
-     * This method provides a workaround.
+     * Writes this object safely. There are issues with serializing primitive class types on certain JVM versions (including java 1.3). This method provides a
+     * workaround.
+     * 
+     * @param out Where to write.
+     * @throws IOException if I/O errors occur while writing to the underlying stream.
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
-
         writeAnyClass(this.type,out);
-
         if (isMapped() || isIndexed()) {
             writeAnyClass(this.contentType,out);
         }
-
         // write out other values
         out.defaultWriteObject();
     }

src/main/java/org/apache/commons/beanutils/converters/AbstractConverter.java

@@ -19,7 +19,6 @@
 import java.lang.reflect.Array;
 import java.util.Collection;
 
-import org.apache.commons.beanutils.BeanUtils;
 import org.apache.commons.beanutils.ConversionException;
 import org.apache.commons.beanutils.ConvertUtils;
 import org.apache.commons.beanutils.Converter;

src/test/java/org/apache/commons/beanutils/BeanMapTestCase.java

@@ -22,14 +22,14 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import junit.framework.Test;
-import junit.textui.TestRunner;
-
 import org.apache.commons.beanutils.bugs.other.Jira87BeanFactory;
 import org.apache.commons.collections.BulkTest;
 import org.apache.commons.collections.Transformer;
 import org.apache.commons.collections.map.AbstractTestMap;
 
+import junit.framework.Test;
+import junit.textui.TestRunner;
+
 /**
  * Test cases for BeanMap
  *

src/test/java/org/apache/commons/beanutils/BeanPredicateTestCase.java

@@ -17,13 +17,13 @@
 
 package org.apache.commons.beanutils;
 
-import junit.framework.TestCase;
-
 import org.apache.commons.collections.functors.EqualPredicate;
 import org.apache.commons.collections.functors.InstanceofPredicate;
 import org.apache.commons.collections.functors.NotPredicate;
 import org.apache.commons.collections.functors.NullPredicate;
 
+import junit.framework.TestCase;
+
 /**
  */
 public class BeanPredicateTestCase extends TestCase {

src/test/java/org/apache/commons/beanutils/BeanUtilsTestCase.java

@@ -24,13 +24,13 @@
 import java.util.Locale;
 import java.util.Map;
 
+import org.apache.commons.beanutils.converters.ArrayConverter;
+import org.apache.commons.beanutils.converters.DateConverter;
+
 import junit.framework.Test;
 import junit.framework.TestCase;
 import junit.framework.TestSuite;
 
-import org.apache.commons.beanutils.converters.ArrayConverter;
-import org.apache.commons.beanutils.converters.DateConverter;
-
 
 /**
  * <p>

src/test/java/org/apache/commons/beanutils/BeanificationTestCase.java

@@ -22,12 +22,12 @@
 import java.util.Map;
 import java.util.WeakHashMap;
 
+import org.apache.commons.logging.LogFactory;
+
 import junit.framework.Test;
 import junit.framework.TestCase;
 import junit.framework.TestSuite;
 
-import org.apache.commons.logging.LogFactory;
-
 /**
  * <p>
  * Test Case for changes made during Beanutils Beanification

src/test/java/org/apache/commons/beanutils/ConvertUtilsTestCase.java

@@ -25,12 +25,12 @@
 import java.text.SimpleDateFormat;
 import java.util.Locale;
 
+import org.apache.commons.beanutils.converters.DateConverter;
+
 import junit.framework.Test;
 import junit.framework.TestCase;
 import junit.framework.TestSuite;
 
-import org.apache.commons.beanutils.converters.DateConverter;
-
 
 /**
  * <p>

src/test/java/org/apache/commons/beanutils/MethodUtilsTestCase.java

@@ -21,13 +21,13 @@
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
 
+import org.apache.commons.beanutils.priv.PrivateBeanFactory;
+import org.apache.commons.beanutils.priv.PublicSubBean;
+
 import junit.framework.Test;
 import junit.framework.TestCase;
 import junit.framework.TestSuite;
 
-import org.apache.commons.beanutils.priv.PrivateBeanFactory;
-import org.apache.commons.beanutils.priv.PublicSubBean;
-
 /**
  * <p> Test case for <code>MethodUtils</code> </p>
  *