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 e60e010c7 Fix Javadoc for ChunkedOutputStream.Builder
e60e010c7 is described below
commit e60e010c786885402fbaa72cc2fd33fb3cd0da73
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Apr 3 08:29:26 2025 -0400
Fix Javadoc for ChunkedOutputStream.Builder
---
src/changes/changes.xml | 1 +
.../java/org/apache/commons/io/output/ChunkedOutputStream.java | 8 +++++---
2 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 9fce2c9eb..9cd71c36e 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -70,6 +70,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.ntfsTimeToFileTime(FileTimes.java:164).
See also https://issues.apache.org/jira/browse/MDEP-978.</action>
<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>
<!-- 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/output/ChunkedOutputStream.java
b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
index a89da0296..201108f90 100644
--- a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java
@@ -43,7 +43,8 @@ public class ChunkedOutputStream extends FilterOutputStream {
* Using File IO:
* </p>
* <pre>{@code
- * UnsynchronizedByteArrayOutputStream s =
UnsynchronizedByteArrayOutputStream.builder()
+ * ChunkedOutputStream s = ChunkedOutputStream.builder()
+ * .setPath("over/there.out")
* .setBufferSize(8192)
* .get();
* }
@@ -52,7 +53,8 @@ public class ChunkedOutputStream extends FilterOutputStream {
* Using NIO Path:
* </p>
* <pre>{@code
- * UnsynchronizedByteArrayOutputStream s =
UnsynchronizedByteArrayOutputStream.builder()
+ * ChunkedOutputStream s = ChunkedOutputStream.builder()
+ * .setPath("over/there.out")
* .setBufferSize(8192)
* .get();
* }
@@ -72,7 +74,7 @@ public Builder() {
}
/**
- * Builds a new {@link UnsynchronizedByteArrayOutputStream}.
+ * Builds a new {@link ChunkedOutputStream}.
* <p>
* This builder uses the following aspects:
* </p>
