Skip to content

Commit aadc8c9

Browse files
committed
Better Javadoc
1 parent e60e010 commit aadc8c9

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

src/changes/changes.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ The <action> type attribute can be add,update,fix,remove.
7171
<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>
7272
<action dev="ggregory" type="fix" due-to="Gary Gregory">FileTimes.toNtfsTime(*) methods can overflow result values.</action>
7373
<action dev="ggregory" type="fix" due-to="Gary Gregory">Fix Javadoc for ChunkedOutputStream.Builder.</action>
74+
<action dev="ggregory" type="fix" due-to="Gary Gregory">General Javadoc improvements.</action>
7475
<!-- ADD -->
7576
<action dev="ggregory" type="add" issue="IO-860" due-to="Nico Strecker, Gary Gregory">Add ThrottledInputStream.Builder.setMaxBytes(long, ChronoUnit).</action>
7677
<action dev="ggregory" type="add" due-to="Gary Gregory">Add IOIterable.</action>

src/main/java/org/apache/commons/io/input/BoundedInputStream.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
/**
2929
* Reads bytes up to a maximum count and stops once reached.
3030
* <p>
31-
* To build an instance, see {@link AbstractBuilder}.
31+
* To build an instance: Use the {@link #builder()} to access all features.
3232
* </p>
3333
* <p>
3434
* 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) {
145145
* Default is {@value IOUtils#EOF}, negative means unbound.
146146
* </p>
147147
*
148-
* @param maxCount The maximum number of bytes to return.
148+
* @param maxCount The maximum number of bytes to return, negative means unbound.
149149
* @return {@code this} instance.
150150
*/
151151
public T setMaxCount(final long maxCount) {
@@ -321,6 +321,9 @@ public static Builder builder() {
321321

322322
/**
323323
* Constructs a new {@link BoundedInputStream} that wraps the given input stream and is <em>unbounded</em>.
324+
* <p>
325+
* To build an instance: Use the {@link #builder()} to access all features.
326+
* </p>
324327
*
325328
* @param in The wrapped input stream.
326329
* @deprecated Use {@link AbstractBuilder#get()}.
@@ -342,7 +345,7 @@ public BoundedInputStream(final InputStream in) {
342345
* Constructs a new {@link BoundedInputStream} that wraps the given input stream and limits it to a certain size.
343346
*
344347
* @param inputStream The wrapped input stream.
345-
* @param maxCount The maximum number of bytes to return.
348+
* @param maxCount The maximum number of bytes to return, negative means unbound.
346349
* @deprecated Use {@link AbstractBuilder#get()}.
347350
*/
348351
@Deprecated

0 commit comments

Comments
 (0)