Skip to content

Commit a5e398f

Browse files
committed
Javadoc and comments
1 parent d5becc4 commit a5e398f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -350,15 +350,15 @@ public BoundedInputStream(final InputStream in) {
350350
*/
351351
@Deprecated
352352
public BoundedInputStream(final InputStream inputStream, final long maxCount) {
353-
// Some badly designed methods - e.g. the Servlet API - overload length
353+
// Some badly designed methods, for example the Servlet API, overload length
354354
// such that "-1" means stream finished
355355
this(inputStream, builder().setMaxCount(maxCount));
356356
}
357357

358358
/**
359359
* Adds the number of read bytes to the count.
360360
*
361-
* @param n number of bytes read, or -1 if no more bytes are available
361+
* @param n number of bytes read, or -1 if no more bytes are available.
362362
* @throws IOException Not thrown here but subclasses may throw.
363363
* @since 2.0
364364
*/
@@ -455,7 +455,7 @@ public boolean isPropagateClose() {
455455
/**
456456
* Invokes the delegate's {@link InputStream#mark(int)} method.
457457
*
458-
* @param readLimit read ahead limit
458+
* @param readLimit read ahead limit.
459459
*/
460460
@Override
461461
public synchronized void mark(final int readLimit) {
@@ -466,7 +466,7 @@ public synchronized void mark(final int readLimit) {
466466
/**
467467
* Invokes the delegate's {@link InputStream#markSupported()} method.
468468
*
469-
* @return true if mark is supported, otherwise false
469+
* @return true if mark is supported, otherwise false.
470470
*/
471471
@Override
472472
public boolean markSupported() {
@@ -508,7 +508,7 @@ public int read() throws IOException {
508508
/**
509509
* Invokes the delegate's {@link InputStream#read(byte[])} method.
510510
*
511-
* @param b the buffer to read the bytes into
511+
* @param b the buffer to read the bytes into.
512512
* @return the number of bytes read or -1 if the end of stream or the limit has been reached.
513513
* @throws IOException if an I/O error occurs.
514514
*/
@@ -520,9 +520,9 @@ public int read(final byte[] b) throws IOException {
520520
/**
521521
* Invokes the delegate's {@link InputStream#read(byte[], int, int)} method.
522522
*
523-
* @param b the buffer to read the bytes into
524-
* @param off The start offset
525-
* @param len The number of bytes to read
523+
* @param b the buffer to read the bytes into.
524+
* @param off The start offset.
525+
* @param len The number of bytes to read.
526526
* @return the number of bytes read or -1 if the end of stream or the limit has been reached.
527527
* @throws IOException if an I/O error occurs.
528528
*/
@@ -561,8 +561,8 @@ public synchronized void setPropagateClose(final boolean propagateClose) {
561561
/**
562562
* Invokes the delegate's {@link InputStream#skip(long)} method.
563563
*
564-
* @param n the number of bytes to skip
565-
* @return the actual number of bytes skipped
564+
* @param n the number of bytes to skip.
565+
* @return the actual number of bytes skipped.
566566
* @throws IOException if an I/O error occurs.
567567
*/
568568
@Override
@@ -579,7 +579,7 @@ private long toReadLen(final long len) {
579579
/**
580580
* Invokes the delegate's {@link InputStream#toString()} method.
581581
*
582-
* @return the delegate's {@link InputStream#toString()}
582+
* @return the delegate's {@link InputStream#toString()}.
583583
*/
584584
@Override
585585
public String toString() {

0 commit comments

Comments
 (0)