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 aadc8c9fc Better Javadoc
aadc8c9fc is described below
commit aadc8c9fc6fcf1e7c7b681834bd5703ef7cec498
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Apr 3 08:37:49 2025 -0400
Better Javadoc
---
src/changes/changes.xml | 1 +
.../java/org/apache/commons/io/input/BoundedInputStream.java | 9 ++++++---
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 9cd71c36e..f62ceaffc 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -71,6 +71,7 @@ The <action> type attribute can be add,update,fix,remove.
<action dev="ggregory" type="fix" issue="IO-873" due-to="Gary
Gregory">java.lang.ArithmeticException: long overflow
java.lang.Math.addExact(Math.java:932) at
org.apache.commons.io.file.attribute.FileTimes.ntfsTimeToDate(long).</action>
<action dev="ggregory" type="fix" due-to="Gary
Gregory">FileTimes.toNtfsTime(*) methods can overflow result values.</action>
<action dev="ggregory" type="fix" due-to="Gary
Gregory">Fix Javadoc for ChunkedOutputStream.Builder.</action>
+ <action dev="ggregory" type="fix" due-to="Gary
Gregory">General Javadoc improvements.</action>
<!-- ADD -->
<action dev="ggregory" type="add" issue="IO-860" due-to="Nico Strecker,
Gary Gregory">Add ThrottledInputStream.Builder.setMaxBytes(long,
ChronoUnit).</action>
<action dev="ggregory" type="add" due-to="Gary
Gregory">Add IOIterable.</action>
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 43ea7775d..14fed6048 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -28,7 +28,7 @@
/**
* Reads bytes up to a maximum count and stops once reached.
* <p>
- * To build an instance, see {@link AbstractBuilder}.
+ * To build an instance: Use the {@link #builder()} to access all features.
* </p>
* <p>
* By default, a {@link BoundedInputStream} is <em>unbound</em>; so make sure
to call {@link AbstractBuilder#setMaxCount(long)}.
@@ -145,7 +145,7 @@ public T setCount(final long count) {
* Default is {@value IOUtils#EOF}, negative means unbound.
* </p>
*
- * @param maxCount The maximum number of bytes to return.
+ * @param maxCount The maximum number of bytes to return, negative
means unbound.
* @return {@code this} instance.
*/
public T setMaxCount(final long maxCount) {
@@ -321,6 +321,9 @@ public static Builder builder() {
/**
* Constructs a new {@link BoundedInputStream} that wraps the given input
stream and is <em>unbounded</em>.
+ * <p>
+ * To build an instance: Use the {@link #builder()} to access all features.
+ * </p>
*
* @param in The wrapped input stream.
* @deprecated Use {@link AbstractBuilder#get()}.
@@ -342,7 +345,7 @@ public BoundedInputStream(final InputStream in) {
* Constructs a new {@link BoundedInputStream} that wraps the given input
stream and limits it to a certain size.
*
* @param inputStream The wrapped input stream.
- * @param maxCount The maximum number of bytes to return.
+ * @param maxCount The maximum number of bytes to return, negative
means unbound.
* @deprecated Use {@link AbstractBuilder#get()}.
*/
@Deprecated
