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
The following commit(s) were added to refs/heads/master by this push:
new dd38ca572 Javadoc improvements
dd38ca572 is described below
commit dd38ca572a74591c9cbb2240c9fa6e5068d01932
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Feb 14 07:52:48 2025 -0500
Javadoc improvements
---
src/main/java/org/apache/commons/io/ByteOrderMark.java | 8 ++++----
.../org/apache/commons/io/input/AutoCloseInputStream.java | 4 ++--
.../java/org/apache/commons/io/input/BOMInputStream.java | 2 +-
.../org/apache/commons/io/input/BoundedInputStream.java | 2 +-
.../commons/io/input/BufferedFileChannelInputStream.java | 5 +++--
.../apache/commons/io/input/CharSequenceInputStream.java | 2 +-
.../org/apache/commons/io/input/ChecksumInputStream.java | 4 ++--
.../io/input/MessageDigestCalculatingInputStream.java | 4 ++--
.../apache/commons/io/input/MessageDigestInputStream.java | 4 ++--
.../org/apache/commons/io/input/ThrottledInputStream.java | 4 ++--
.../org/apache/commons/io/output/ChunkedOutputStream.java | 6 +++---
.../apache/commons/io/output/FileWriterWithEncoding.java | 13 +++++++------
12 files changed, 30 insertions(+), 28 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/ByteOrderMark.java
b/src/main/java/org/apache/commons/io/ByteOrderMark.java
index 6017a728c..92f1c9960 100644
--- a/src/main/java/org/apache/commons/io/ByteOrderMark.java
+++ b/src/main/java/org/apache/commons/io/ByteOrderMark.java
@@ -193,10 +193,6 @@ public byte[] getBytes() {
return copy;
}
- int[] getRawBytes() {
- return bytes;
- }
-
/**
* Gets the name of the {@link java.nio.charset.Charset} the BOM
represents.
*
@@ -206,6 +202,10 @@ public String getCharsetName() {
return charsetName;
}
+ int[] getRawBytes() {
+ return bytes;
+ }
+
/**
* Computes the hash code for this BOM.
*
diff --git
a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
index 516e704f0..42097318f 100644
--- a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
@@ -78,13 +78,13 @@ public Builder() {
* This builder uses the following aspects:
* </p>
* <ul>
- * <li>{@link #getInputStream()}</li>
+ * <li>{@link #getInputStream()} gets the target aspect.</li>
* </ul>
*
* @return a new instance.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs
converting to an {@link InputStream} using {@link #getInputStream()}.
* @see #getInputStream()
* @see #getUnchecked()
*/
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 2096e5923..95177578d 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -168,7 +168,7 @@ public Builder() {
* @return a new instance.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs
converting to an {@link InputStream} using {@link #getInputStream()}.
* @see #getInputStream()
* @see #getUnchecked()
*/
diff --git a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
index 1c0135144..43ea7775d 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -261,7 +261,7 @@ public Builder() {
* This builder uses the following aspects:
* </p>
* <ul>
- * <li>{@link #getInputStream()} (the target aspect)</li>
+ * <li>{@link #getInputStream()} gets the target aspect.</li>
* <li>{@link #getAfterRead()}</li>
* <li>{@link #getCount()}</li>
* <li>{@link #getMaxCount()}</li>
diff --git
a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
index 21cf7897d..29b89aa81 100644
---
a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
+++
b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
@@ -91,14 +91,15 @@ public Builder() {
* This builder uses the following aspects:
* </p>
* <ul>
- * <li>{@link #getInputStream()}</li>
+ * <li>{@link FileChannel} takes precedence is set. </li>
+ * <li>{@link #getPath()} if the file channel is not set.</li>
* <li>{@link #getBufferSize()}</li>
* </ul>
*
* @return a new instance.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to a {@link Path}.
- * @throws IOException If an I/O error occurs
+ * @throws IOException if an I/O error occurs
converting to an {@link Path} using {@link #getPath()}.
* @see #getPath()
* @see #getBufferSize()
* @see #getUnchecked()
diff --git
a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
index d33ba4474..9653866a0 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -101,7 +101,7 @@ public Builder() {
* This builder uses the following aspects:
* </p>
* <ul>
- * <li>{@link #getCharSequence()}</li>
+ * <li>{@link #getCharSequence()} gets the target aspect.</li>
* <li>{@link #getBufferSize()}</li>
* <li>{@link CharsetEncoder}</li>
* </ul>
diff --git a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
index 80cbd3bae..f02f154cc 100644
--- a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
@@ -134,7 +134,7 @@ public Builder() {
* This builder uses the following aspects:
* </p>
* <ul>
- * <li>{@link #getInputStream()}</li>
+ * <li>{@link #getInputStream()} gets the target aspect.</li>
* <li>{@link Checksum}</li>
* <li>expectedChecksumValue</li>
* <li>countThreshold</li>
@@ -143,7 +143,7 @@ public Builder() {
* @return a new instance.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs
converting to an {@link InputStream} using {@link #getInputStream()}.
* @see #getInputStream()
* @see #getUnchecked()
*/
diff --git
a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
index a47293ed0..ce490989d 100644
---
a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
+++
b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
@@ -92,7 +92,7 @@ public Builder() {
* This builder uses the following aspects:
* </p>
* <ul>
- * <li>{@link #getPath()}</li>
+ * <li>{@link #getInputStream()} gets the target aspect.</li>
* <li>{@link MessageDigest}</li>
* </ul>
*
@@ -100,7 +100,7 @@ public Builder() {
* @throws NullPointerException if messageDigest is null.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs
converting to an {@link InputStream} using {@link #getInputStream()}.
* @see #getInputStream()
* @see #getUnchecked()
*/
diff --git
a/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
b/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
index 1d8b20d73..ea5ce2983 100644
--- a/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MessageDigestInputStream.java
@@ -91,7 +91,7 @@ public Builder() {
* This builder uses the following aspects:
* </p>
* <ul>
- * <li>{@link #getPath()}</li>
+ * <li>{@link #getInputStream()} gets the target aspect.</li>
* <li>{@link MessageDigest}</li>
* </ul>
*
@@ -99,7 +99,7 @@ public Builder() {
* @throws NullPointerException if messageDigest is null.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs
converting to an {@link InputStream} using {@link #getInputStream()}.
* @see #getInputStream()
* @see #getUnchecked()
*/
diff --git
a/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java
b/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java
index d5dcb0888..2b1eafa3b 100644
--- a/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java
@@ -95,14 +95,14 @@ public Builder() {
* This builder uses the following aspects:
* </p>
* <ul>
- * <li>{@link #getInputStream()}</li>
+ * <li>{@link #getInputStream()} gets the target aspect.</li>
* <li>maxBytesPerSecond</li>
* </ul>
*
* @return a new instance.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs
converting to an {@link InputStream} using {@link #getInputStream()}.
* @see #getInputStream()
* @see #getUnchecked()
*/
diff --git
a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
index 351200016..1b048a24b 100644
--- a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
@@ -77,14 +77,14 @@ public Builder() {
* This builder use the following aspects:
* </p>
* <ul>
- * <li>{@link #getInputStream()}</li>
- * <li>{@link #getBufferSize()} (chunk size)</li>
+ * <li>{@link #getOutputStream()} is the target aspect.</li>
+ * <li>{@link #getBufferSize()} is used for the chunk size.</li>
* </ul>
*
* @return a new instance.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to an {@link OutputStream}.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs
converting to an {@link OutputStream} using {@link #getOutputStream()}.
* @see #getOutputStream()
* @see #getBufferSize()
* @see #getUnchecked()
diff --git
a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
index 528e0c737..d41b5280a 100644
--- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
+++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
@@ -103,14 +103,15 @@ public Builder() {
* This builder use the following aspects:
* </p>
* <ul>
- * <li>{@link File}</li>
+ * <li>{@link File} is the target aspect.</li>
* <li>{@link CharsetEncoder}</li>
* <li>append</li>
* </ul>
*
* @return a new instance.
* @throws UnsupportedOperationException if the origin cannot provide
a File.
- * @throws IllegalStateException if the {@code origin} is {@code null}.
+ * @throws IllegalStateException if the {@code origin} is
{@code null}.
+ * @throws IOException if an I/O error occurs
converting to an {@link File} using {@link #getFile()}.
* @see AbstractOrigin#getFile()
* @see #getUnchecked()
*/
@@ -160,11 +161,11 @@ public static Builder builder() {
/**
* Initializes the wrapped file writer. Ensure that a cleanup occurs if
the writer creation fails.
*
- * @param file the file to be accessed
+ * @param file the file to be accessed.
* @param encoding the encoding to use - may be Charset, CharsetEncoder or
String, null uses the default Charset.
- * @param append true to append
- * @return a new initialized OutputStreamWriter
- * @throws IOException if an error occurs
+ * @param append true to append.
+ * @return a new initialized OutputStreamWriter.
+ * @throws IOException if an I/O error occurs.
*/
private static OutputStreamWriter initWriter(final File file, final Object
encoding, final boolean append) throws IOException {
Objects.requireNonNull(file, "file");
