You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2025/07/01 22:10:26 UTC
(commons-io) branch master updated (11e8800e5 -> 7d7f44815)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
from 11e8800e5 Internal refactoring
new 9c6a84ea6 Comments
new 7d7f44815 Javadoc
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/main/java/org/apache/commons/io/input/BOMInputStream.java | 10 ++++------
src/main/java/org/apache/commons/io/input/NullInputStream.java | 4 ++--
src/main/java/org/apache/commons/io/input/NullReader.java | 4 ++--
3 files changed, 8 insertions(+), 10 deletions(-)
(commons-io) 02/02: Javadoc
Posted by gg...@apache.org.
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 7d7f44815de6d28dfbf43c698962c0db3943310b
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Jul 1 18:10:21 2025 -0400
Javadoc
---
src/main/java/org/apache/commons/io/input/NullInputStream.java | 4 ++--
src/main/java/org/apache/commons/io/input/NullReader.java | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/NullInputStream.java b/src/main/java/org/apache/commons/io/input/NullInputStream.java
index c64a9fafc..4d731c291 100644
--- a/src/main/java/org/apache/commons/io/input/NullInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/NullInputStream.java
@@ -23,9 +23,9 @@
import java.io.InputStream;
/**
- * A light weight {@link InputStream} that emulates a stream of a specified size.
+ * A lightweight {@link InputStream} that emulates a stream of a specified size.
* <p>
- * This implementation provides a light weight object for testing with an {@link InputStream} where the contents don't matter.
+ * This implementation provides a lightweight object for testing with an {@link InputStream} where the contents don't matter.
* </p>
* <p>
* One use case would be for testing the handling of large {@link InputStream} as it can emulate that scenario without the overhead of actually processing large
diff --git a/src/main/java/org/apache/commons/io/input/NullReader.java b/src/main/java/org/apache/commons/io/input/NullReader.java
index 3f20d5d69..d1fcf591d 100644
--- a/src/main/java/org/apache/commons/io/input/NullReader.java
+++ b/src/main/java/org/apache/commons/io/input/NullReader.java
@@ -23,10 +23,10 @@
import java.io.Reader;
/**
- * A functional, light weight {@link Reader} that emulates
+ * A functional, lightweight {@link Reader} that emulates
* a reader of a specified size.
* <p>
- * This implementation provides a light weight
+ * This implementation provides a lightweight
* object for testing with an {@link Reader}
* where the contents don't matter.
* </p>
(commons-io) 01/02: Comments
Posted by gg...@apache.org.
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 9c6a84ea6cc7c50e07dff576d6bdb9da12364dc2
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Jul 1 18:04:19 2025 -0400
Comments
---
src/main/java/org/apache/commons/io/input/BOMInputStream.java | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
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 e7b6c3c47..47c7e0604 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -484,13 +484,11 @@ private ByteOrderMark readBom() throws IOException {
}
/**
- * This method reads and either preserves or skips the first bytes in the stream. It behaves like the single-byte
- * {@code read()} method, either returning a valid byte or -1 to indicate that the initial bytes have been
- * processed already.
+ * Reads and either preserves or skips the first bytes in the stream. This method behaves like the single-byte {@code read()} method, either returning a
+ * valid byte or -1 to indicate that the initial bytes have been processed already.
*
- * @return the byte read (excluding BOM) or -1 if the end of stream
- * @throws IOException
- * if an I/O error occurs
+ * @return the byte read (excluding BOM) or -1 if at the end of first bytes.
+ * @throws IOException if an I/O error occurs
*/
private int readFirstBytes() throws IOException {
getBOM();