This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
commit cae58ff44df32ce2bd4e6a15d7344c06eb8b7932
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Dec 22 15:22:17 2023 -0500
Javadoc
---
.../org/apache/commons/io/IOExceptionList.java | 3 +++
.../commons/io/input/CharSequenceReader.java | 6 +++++
.../commons/io/input/XmlStreamReaderException.java | 29 ++++++++++++++++------
.../commons/io/monitor/FileAlterationObserver.java | 28 ++++++++++++++++-----
.../io/output/AbstractByteArrayOutputStream.java | 8 ++++--
5 files changed, 59 insertions(+), 15 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/IOExceptionList.java
b/src/main/java/org/apache/commons/io/IOExceptionList.java
index c8bd4bf9..7db7fb8d 100644
--- a/src/main/java/org/apache/commons/io/IOExceptionList.java
+++ b/src/main/java/org/apache/commons/io/IOExceptionList.java
@@ -63,6 +63,9 @@ public class IOExceptionList extends IOException implements
Iterable<Throwable>
return String.format("%,d exception(s): %s", size(causeList),
causeList);
}
+ /**
+ * List of causes.
+ */
private final List<? extends Throwable> causeList;
/**
diff --git a/src/main/java/org/apache/commons/io/input/CharSequenceReader.java
b/src/main/java/org/apache/commons/io/input/CharSequenceReader.java
index f8cc8202..1d2062b2 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceReader.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceReader.java
@@ -38,8 +38,14 @@ import java.util.Objects;
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;
/**
diff --git
a/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
b/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
index 1402a748..cbaa844a 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
+++ b/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 class XmlStreamReaderException extends IOException {
}
/**
- * 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 class XmlStreamReaderException extends IOException {
}
/**
- * 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 class XmlStreamReaderException extends IOException {
}
/**
- * 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 class XmlStreamReaderException extends IOException {
}
/**
- * 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 class XmlStreamReaderException extends IOException {
}
/**
- * 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 class XmlStreamReaderException extends IOException {
}
/**
- * 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.
*/
diff --git
a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
index b93dd8d9..c5960c44 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
@@ -130,9 +130,25 @@ import org.apache.commons.io.filefilter.TrueFileFilter;
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 class FileAlterationObserver implements Serializable
{
* 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 class FileAlterationObserver implements Serializable
{
/**
* 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");
diff --git
a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
index 6e47aa39..830624d9 100644
---
a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
+++
b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
@@ -143,12 +143,16 @@ public abstract class AbstractByteArrayOutputStream
extends OutputStream {
}
/**
- * @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;
