Javadoc

Author: garydgregory

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

@@ -73,12 +73,12 @@
  *   .get();
  * }
  * </pre>
- * <h2>Listening for the max count reached</h2>
+ * <h2>Listening for the maximum count reached</h2>
  * <pre>{@code
  * BoundedInputStream s = BoundedInputStream.builder()
  *   .setPath(Paths.get("MyFile.xml"))
  *   .setMaxCount(1024)
- *   .setOnMaxCount((max, count) -> System.out.printf("Max count %,d reached with a last read count of %,d%n", max, count))
+ *   .setOnMaxCount((max, count) -> System.out.printf("Maximum count %,d reached with a last read count of %,d%n", max, count))
  *   .get();
  * }
  * </pre>
@@ -98,7 +98,7 @@ abstract static class AbstractBuilder<T extends AbstractBuilder<T>> extends Prox
         /** The current count of bytes counted. */
         private long count;
 
-        /** The max count of bytes to read. */
+        /** The maximum count of bytes to read. */
         private long maxCount = EOF;
 
         private IOBiConsumer<Long, Long> onMaxCount = IOBiConsumer.noop();
@@ -156,7 +156,7 @@ public T setMaxCount(final long maxCount) {
         /**
          * Sets the default {@link BoundedInputStream#onMaxLength(long, long)} behavior, {@code null} resets to a NOOP.
          * <p>
-         * The first Long is the max count of bytes to read. The second Long is the count of bytes read.
+         * The first Long is the number of bytes remaining to read before the maximum is reached count of bytes to read. The second Long is the count of bytes read.
          * </p>
          * <p>
          * This does <em>not</em> override a {@code BoundedInputStream} subclass' implementation of the {@link BoundedInputStream#onMaxLength(long, long)}
@@ -299,7 +299,7 @@ public static Builder builder() {
     /** The current mark. */
     private long mark;
 
-    /** The max count of bytes to read. */
+    /** The maximum count of bytes to read. */
     private final long maxCount;
 
     private final IOBiConsumer<Long, Long> onMaxCount;
@@ -410,9 +410,9 @@ public long getMaxCount() {
     }
 
     /**
-     * Gets the max count of bytes to read.
+     * Gets the maximum count of bytes to read.
      *
-     * @return The max count of bytes to read.
+     * @return The maximum count of bytes to read.
      * @since 2.12.0
      * @deprecated Use {@link #getMaxCount()}.
      */
@@ -479,7 +479,7 @@ public boolean markSupported() {
      * Delegates to the consumer set in {@link Builder#setOnMaxCount(IOBiConsumer)}.
      * </p>
      *
-     * @param max The max count of bytes to read.
+     * @param max The maximum count of bytes to read.
      * @param count     The count of bytes read.
      * @throws IOException Subclasses may throw.
      * @since 2.12.0