Fix checkstyle errors

bug 38145, from Niall Pemberton

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk@369075 13f79535-47bb-0310-9956-ffa450edef68

Author: Stephen Colebourne

checkstyle.xml

@@ -31,6 +31,7 @@ limitations under the License.
     <module name="NeedBraces"/>
     <module name="RedundantThrows">
       <property name="allowUnchecked" value="true"/>
+      <property name="allowSubclasses" value="true"/>
     </module>
     <module name="LineLength">
       <property name="max" value="120"/>

src/java/org/apache/commons/io/HexDump.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002,2004-2005 The Apache Software Foundation.
+ * Copyright 2002,2004-2006 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,9 +42,9 @@ public HexDump() {
     /**
      * Dump an array of bytes to an OutputStream.
      *
-     * @param data the byte array to be dumped
-     * @param offset its offset, whatever that might mean
-     * @param stream the OutputStream to which the data is to be
+     * @param data  the byte array to be dumped
+     * @param offset  its offset, whatever that might mean
+     * @param stream  the OutputStream to which the data is to be
      *               written
      * @param index initial index into the byte array
      *
@@ -118,6 +118,12 @@ public static void dump(byte[] data, long offset,
                 28, 24, 20, 16, 12, 8, 4, 0
             };
 
+    /**
+     * Dump a long value into a StringBuffer.
+     *
+     * @param value  the long value to be dumped
+     * @return StringBuffer containing the dumped value.
+     */
     private static StringBuffer dump(long value) {
         _lbuffer.setLength(0);
         for (int j = 0; j < 8; j++) {
@@ -127,11 +133,18 @@ private static StringBuffer dump(long value) {
         return _lbuffer;
     }
 
+    /**
+     * Dump a byte value into a StringBuffer.
+     *
+     * @param value  the byte value to be dumped
+     * @return StringBuffer containing the dumped value.
+     */
     private static StringBuffer dump(byte value) {
         _cbuffer.setLength(0);
         for (int j = 0; j < 2; j++) {
             _cbuffer.append(_hexcodes[(value >> _shifts[j + 6]) & 15]);
         }
         return _cbuffer;
     }
+
 }

src/java/org/apache/commons/io/filefilter/AgeFileFilter.java

@@ -50,7 +50,7 @@ public class AgeFileFilter extends AbstractFileFilter {
     /**
      * Constructs a new age file filter for files older than a certain cutoff.
      *
-     * @param age  the threshold age of the files
+     * @param cutoff  the threshold age of the files
      */
     public AgeFileFilter(long cutoff) {
         this(cutoff, true);
@@ -60,7 +60,7 @@ public AgeFileFilter(long cutoff) {
      * Constructs a new age file filter for files on any one side
      * of a certain cutoff.
      *
-     * @param age  the threshold age of the files
+     * @param cutoff  the threshold age of the files
      * @param acceptOlder  if true, older files are accepted, else newer ones
      */
     public AgeFileFilter(long cutoff, boolean acceptOlder) {
@@ -72,7 +72,7 @@ public AgeFileFilter(long cutoff, boolean acceptOlder) {
      * Constructs a new age file filter for files older than a certain
      * cutoff date.
      *
-     * @param age  the threshold age of the files
+     * @param cutoffDate  the threshold age of the files
      */
     public AgeFileFilter(Date cutoffDate) {
         this(cutoffDate, true);
@@ -82,7 +82,7 @@ public AgeFileFilter(Date cutoffDate) {
      * Constructs a new age file filter for files on any one side
      * of a certain cutoff date.
      *
-     * @param age  the threshold age of the files
+     * @param cutoffDate  the threshold age of the files
      * @param acceptOlder  if true, older files are accepted, else newer ones
      */
     public AgeFileFilter(Date cutoffDate, boolean acceptOlder) {
@@ -93,7 +93,8 @@ public AgeFileFilter(Date cutoffDate, boolean acceptOlder) {
      * Constructs a new age file filter for files older than a certain
      * File (whose last modification time will be used as reference).
      *
-     * @param age  the threshold age of the files
+     * @param cutoffReference  the file whose last modification
+     *        time is usesd as the threshold age of the files
      */
     public AgeFileFilter(File cutoffReference) {
         this(cutoffReference, true);
@@ -104,7 +105,8 @@ public AgeFileFilter(File cutoffReference) {
      * of a certain File (whose last modification time will be used as
      * reference).
      *
-     * @param age  the threshold age of the files
+     * @param cutoffReference  the file whose last modification
+     *        time is usesd as the threshold age of the files
      * @param acceptOlder  if true, older files are accepted, else newer ones
      */
     public AgeFileFilter(File cutoffReference, boolean acceptOlder) {

src/java/org/apache/commons/io/filefilter/FileFilterUtils.java

@@ -237,7 +237,7 @@ public static IOFileFilter ageFileFilter(long cutoff, boolean acceptOlder) {
      * Returns a filter that returns true if the file was last modified after
      * the specified cutoff date.
      *
-     * @param cutoff  the time threshold
+     * @param cutoffDate  the time threshold
      * @return an appropriately configured age file filter
      * @since Commons IO 1.2
      */
@@ -248,7 +248,7 @@ public static IOFileFilter ageFileFilter(Date cutoffDate) {
     /**
      * Returns a filter that filters files based on a cutoff date.
      *
-     * @param cutoff  the time threshold
+     * @param cutoffDate  the time threshold
      * @param acceptOlder  if true, older files get accepted, if false, newer
      * @return an appropriately configured age file filter
      * @since Commons IO 1.2
@@ -261,7 +261,8 @@ public static IOFileFilter ageFileFilter(Date cutoffDate, boolean acceptOlder) {
      * Returns a filter that returns true if the file was last modified after
      * the specified reference file.
      *
-     * @param cutoff  the time threshold
+     * @param cutoffReference  the file whose last modification
+     *        time is usesd as the threshold age of the files
      * @return an appropriately configured age file filter
      * @since Commons IO 1.2
      */
@@ -272,7 +273,8 @@ public static IOFileFilter ageFileFilter(File cutoffReference) {
     /**
      * Returns a filter that filters files based on a cutoff reference file.
      *
-     * @param cutoff  the time threshold
+     * @param cutoffReference  the file whose last modification
+     *        time is usesd as the threshold age of the files
      * @param acceptOlder  if true, older files get accepted, if false, newer
      * @return an appropriately configured age file filter
      * @since Commons IO 1.2
@@ -285,7 +287,7 @@ public static IOFileFilter ageFileFilter(File cutoffReference, boolean acceptOld
     /**
      * Returns a filter that returns true if the file is bigger than a certain size.
      *
-     * @param long  the file size threshold
+     * @param threshold  the file size threshold
      * @return an appropriately configured SizeFileFilter
      * @since Commons IO 1.2
      */
@@ -296,7 +298,7 @@ public static IOFileFilter sizeFileFilter(long threshold) {
     /**
      * Returns a filter that filters based on file size.
      *
-     * @param long  the file size threshold
+     * @param threshold  the file size threshold
      * @param acceptLarger  if true, larger files get accepted, if false, smaller
      * @return an appropriately configured SizeFileFilter
      * @since Commons IO 1.2

src/java/org/apache/commons/io/input/ClassLoaderObjectInputStream.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2001-2005 The Apache Software Foundation.
+ * Copyright 2001-2006 The Apache Software Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,7 +51,15 @@ public ClassLoaderObjectInputStream(
         this.classLoader = classLoader;
     }
 
-    /** @inheritDoc */
+    /**
+     * Resolve a class specified by the descriptor using the
+     * specified ClassLoader or the super ClassLoader.
+     *
+     * @param objectStreamClass  descriptor of the class
+     * @return the Class object described by the ObjectStreamClass
+     * @throws IOException in case of an I/O error
+     * @throws ClassNotFoundException if the Class cannot be found
+     */
     protected Class resolveClass(ObjectStreamClass objectStreamClass)
             throws IOException, ClassNotFoundException {
 

src/java/org/apache/commons/io/output/ByteArrayOutputStream.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2003,2004 The Apache Software Foundation.
+ * Copyright 2003-2006 The Apache Software Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -64,8 +64,8 @@ public ByteArrayOutputStream() {
      * Creates a new byte array output stream, with a buffer capacity of 
      * the specified size, in bytes. 
      *
-     * @param size the initial size.
-     * @exception IllegalArgumentException if size is negative.
+     * @param size  the initial size
+     * @throws IllegalArgumentException if size is negative
      */
     public ByteArrayOutputStream(int size) {
         if (size < 0) {
@@ -75,10 +75,23 @@ public ByteArrayOutputStream(int size) {
         needNewBuffer(size);
     }
 
+    /**
+     * Return the appropriate <code>byte[]</code> buffer 
+     * specified by index.
+     *
+     * @param index  the index of the buffer required
+     * @return the buffer
+     */
     private byte[] getBuffer(int index) {
         return (byte[])buffers.get(index);
     }
 
+    /**
+     * Makes a new buffer available either by allocating
+     * a new one or re-cycling an existing one.
+     *
+     * @param newcount  the size of the buffer if one is created
+     */
     private void needNewBuffer(int newcount) {
         if (currentBufferIndex < buffers.size() - 1) {
             //Recycling old buffer
@@ -168,7 +181,7 @@ public synchronized void reset() {
         currentBufferIndex = 0;
         currentBuffer = getBuffer(currentBufferIndex);
     }
-    
+
     /**
      * @see java.io.ByteArrayOutputStream#writeTo(OutputStream)
      */