Javadoc

Author: garydgregory

src/main/java/org/apache/commons/io/IOExceptionList.java

@@ -63,6 +63,9 @@ private static String toMessage(final List<? extends Throwable> causeList) {
         return String.format("%,d exception(s): %s", size(causeList), causeList);
     }
 
+    /**
+     * List of causes.
+     */
     private final List<? extends Throwable> causeList;
 
     /**

src/main/java/org/apache/commons/io/input/CharSequenceReader.java

@@ -38,8 +38,14 @@
 public class CharSequenceReader extends Reader implements Serializable {
 
     private static final long serialVersionUID = 3724187752191401220L;
+
+    /** Source for reading. */
     private final CharSequence charSequence;
+
+    /** Reading index. */
     private int idx;
+
+    /** Reader mark. */
     private int mark;
 
     /**

src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java

@@ -35,18 +35,33 @@ public class XmlStreamReaderException extends IOException {
 
     private static final long serialVersionUID = 1L;
 
+    /**
+     * The Byte-Order-Mark (BOM) encoding or null.
+     */
     private final String bomEncoding;
 
+    /**
+     * The guessed encoding.
+     */
     private final String xmlGuessEncoding;
 
+    /**
+     * The XML encoding.
+     */
     private final String xmlEncoding;
 
+    /**
+     * The MIME type in the content type.
+     */
     private final String contentTypeMime;
 
+    /**
+     * The encoding in the content type.
+     */
     private final String contentTypeEncoding;
 
     /**
-     * Constructs an exception instance if the charset encoding could not be
+     * Constructs an exception instance if the Charset encoding could not be
      * determined.
      * <p>
      * Instances of this exception are thrown by the XmlStreamReader.
@@ -63,7 +78,7 @@ public XmlStreamReaderException(final String msg, final String bomEnc,
     }
 
     /**
-     * Constructs an exception instance if the charset encoding could not be
+     * Constructs an exception instance if the Charset encoding could not be
      * determined.
      * <p>
      * Instances of this exception are thrown by the XmlStreamReader.
@@ -87,7 +102,7 @@ public XmlStreamReaderException(final String msg, final String ctMime, final Str
     }
 
     /**
-     * Returns the BOM encoding found in the InputStream.
+     * Gets the BOM encoding found in the InputStream.
      *
      * @return the BOM encoding, null if none.
      */
@@ -96,7 +111,7 @@ public String getBomEncoding() {
     }
 
     /**
-     * Returns the encoding in the content-type used to attempt determining the
+     * Gets the encoding in the content-type used to attempt determining the
      * encoding.
      *
      * @return the encoding in the content-type, null if there was not
@@ -108,7 +123,7 @@ public String getContentTypeEncoding() {
     }
 
     /**
-     * Returns the MIME type in the content-type used to attempt determining the
+     * Gets the MIME type in the content-type used to attempt determining the
      * encoding.
      *
      * @return the MIME type in the content-type, null if there was not
@@ -119,7 +134,7 @@ public String getContentTypeMime() {
     }
 
     /**
-     * Returns the encoding found in the XML prolog of the InputStream.
+     * Gets the encoding found in the XML prolog of the input.
      *
      * @return the encoding of the XML prolog, null if none.
      */
@@ -128,7 +143,7 @@ public String getXmlEncoding() {
     }
 
     /**
-     * Returns the encoding guess based on the first bytes of the InputStream.
+     * Gets the encoding guess based on the first bytes of the input.
      *
      * @return the encoding guess, null if it couldn't be guessed.
      */

src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java

@@ -130,9 +130,25 @@
 public class FileAlterationObserver implements Serializable {
 
     private static final long serialVersionUID = 1185122225658782848L;
+
+    /**
+     * List of listeners.
+     */
     private transient final List<FileAlterationListener> listeners = new CopyOnWriteArrayList<>();
+
+    /**
+     * The root directory to observe.
+     */
     private final FileEntry rootEntry;
+
+    /**
+     * The file filter or null if none.
+     */
     private transient final FileFilter fileFilter;
+
+    /**
+     * Compares file names.
+     */
     private final Comparator<File> comparator;
 
     /**
@@ -158,9 +174,9 @@ public FileAlterationObserver(final File directory, final FileFilter fileFilter)
      * Constructs an observer for the specified directory, file filter and
      * file comparator.
      *
-     * @param directory the directory to observe
-     * @param fileFilter The file filter or null if none
-     * @param ioCase  what case sensitivity to use comparing file names, null means system sensitive
+     * @param directory the directory to observe.
+     * @param fileFilter The file filter or null if none.
+     * @param ioCase  what case sensitivity to use comparing file names, null means system sensitive.
      */
     public FileAlterationObserver(final File directory, final FileFilter fileFilter, final IOCase ioCase) {
         this(new FileEntry(directory), fileFilter, ioCase);
@@ -169,9 +185,9 @@ public FileAlterationObserver(final File directory, final FileFilter fileFilter,
     /**
      * Constructs an observer for the specified directory, file filter and file comparator.
      *
-     * @param rootEntry the root directory to observe
-     * @param fileFilter The file filter or null if none
-     * @param ioCase what case sensitivity to use comparing file names, null means system sensitive
+     * @param rootEntry the root directory to observe.
+     * @param fileFilter The file filter or null if none.
+     * @param ioCase what case sensitivity to use comparing file names, null means system sensitive.
      */
     protected FileAlterationObserver(final FileEntry rootEntry, final FileFilter fileFilter, final IOCase ioCase) {
         Objects.requireNonNull(rootEntry, "rootEntry");

src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java

@@ -143,12 +143,16 @@ protected void needNewBuffer(final int newCount) {
     }
 
     /**
-     * @see java.io.ByteArrayOutputStream#reset()
+     * See {@link ByteArrayOutputStream#reset()}.
+     *
+     * @see ByteArrayOutputStream#reset()
      */
     public abstract void reset();
 
     /**
-     * @see java.io.ByteArrayOutputStream#reset()
+     * Implements a default reset behavior.
+     *
+     * @see ByteArrayOutputStream#reset()
      */
     protected void resetImpl() {
         count = 0;