Javadoc

Author: garydgregory

src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java

@@ -230,7 +230,7 @@ protected Writer getWriter() throws IOException {
      * </p>
      *
      * @param bufferSize the buffer size.
-     * @return this.
+     * @return {@code this} instance.
      */
     public B setBufferSize(final int bufferSize) {
         this.bufferSize = checkBufferSize(bufferSize > 0 ? bufferSize : bufferSizeDefault);
@@ -244,7 +244,7 @@ public B setBufferSize(final int bufferSize) {
      * </p>
      *
      * @param bufferSize the buffer size, null resets to the default.
-     * @return this.
+     * @return {@code this} instance.
      */
     public B setBufferSize(final Integer bufferSize) {
         setBufferSize(bufferSize != null ? bufferSize : bufferSizeDefault);
@@ -270,7 +270,7 @@ public B setBufferSizeChecker(final IntUnaryOperator bufferSizeChecker) {
      * </p>
      *
      * @param bufferSizeDefault the buffer size, null resets to the default.
-     * @return this.
+     * @return {@code this} instance.
      */
     protected B setBufferSizeDefault(final int bufferSizeDefault) {
         this.bufferSizeDefault = bufferSizeDefault;
@@ -282,7 +282,7 @@ protected B setBufferSizeDefault(final int bufferSizeDefault) {
      * exceeded, this methods throws an {@link IllegalArgumentException}.
      *
      * @param bufferSizeMax maximum buffer size checked by the buffer size checker.
-     * @return this.
+     * @return {@code this} instance.
      * @since 2.14.0
      */
     public B setBufferSizeMax(final int bufferSizeMax) {
@@ -297,7 +297,7 @@ public B setBufferSizeMax(final int bufferSizeMax) {
      * </p>
      *
      * @param charset the Charset, null resets to the default.
-     * @return this.
+     * @return {@code this} instance.
      */
     public B setCharset(final Charset charset) {
         this.charset = Charsets.toCharset(charset, charsetDefault);
@@ -311,7 +311,7 @@ public B setCharset(final Charset charset) {
      * </p>
      *
      * @param charset the Charset name, null resets to the default.
-     * @return this.
+     * @return {@code this} instance.
      */
     public B setCharset(final String charset) {
         return setCharset(Charsets.toCharset(charset, charsetDefault));
@@ -324,7 +324,7 @@ public B setCharset(final String charset) {
      * </p>
      *
      * @param defaultCharset the Charset name, null resets to the default.
-     * @return this.
+     * @return {@code this} instance.
      */
     protected B setCharsetDefault(final Charset defaultCharset) {
         this.charsetDefault = defaultCharset;
@@ -341,7 +341,7 @@ protected B setCharsetDefault(final Charset defaultCharset) {
      * </p>
      *
      * @param openOptions the OpenOption[] name, null resets to the default.
-     * @return this.
+     * @return {@code this} instance.
      * @since 2.13.0
      * @see #setInputStream(InputStream)
      * @see #setOutputStream(OutputStream)

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

@@ -117,7 +117,7 @@ boolean isPropagateClose() {
          * </p>
          *
          * @param count The current number of bytes counted.
-         * @return this.
+         * @return {@code this} instance.
          */
         public T setCount(final long count) {
             this.count = Math.max(0, count);
@@ -131,7 +131,7 @@ public T setCount(final long count) {
          * </p>
          *
          * @param maxCount The maximum number of bytes to return.
-         * @return this.
+         * @return {@code this} instance.
          */
         public T setMaxCount(final long maxCount) {
             this.maxCount = Math.max(EOF, maxCount);
@@ -146,7 +146,7 @@ public T setMaxCount(final long maxCount) {
          *
          * @param propagateClose {@code true} if calling {@link #close()} propagates to the {@code close()} method of the underlying stream or {@code false} if
          *                       it does not.
-         * @return this.
+         * @return {@code this} instance.
          */
         public T setPropagateClose(final boolean propagateClose) {
             this.propagateClose = propagateClose;

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

@@ -149,7 +149,7 @@ public ChecksumInputStream get() throws IOException {
          * Sets the Checksum.
          *
          * @param checksum the Checksum.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setChecksum(final Checksum checksum) {
             this.checksum = checksum;
@@ -164,7 +164,7 @@ public Builder setChecksum(final Checksum checksum) {
          * </p>
          *
          * @param countThreshold the count threshold. A negative number means the threshold is unbound.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setCountThreshold(final long countThreshold) {
             this.countThreshold = countThreshold;
@@ -175,7 +175,7 @@ public Builder setCountThreshold(final long countThreshold) {
          * The expected {@link Checksum} value once the stream is exhausted or the count threshold is reached.
          *
          * @param expectedChecksumValue The expected Checksum value.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setExpectedChecksumValue(final long expectedChecksumValue) {
             this.expectedChecksumValue = expectedChecksumValue;

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

@@ -116,7 +116,7 @@ public Builder setBlockingQueue(final BlockingQueue<Integer> blockingQueue) {
          * Sets the polling timeout.
          *
          * @param timeout the polling timeout.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setTimeout(final Duration timeout) {
             if (timeout != null && timeout.toNanos() < 0) {

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

@@ -274,7 +274,7 @@ public Builder setStartThread(final boolean startThread) {
          * Sets the tailable.
          *
          * @param tailable the tailable.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setTailable(final Tailable tailable) {
             this.tailable = Objects.requireNonNull(tailable, "tailable");

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

@@ -118,7 +118,7 @@ public Builder setByteArray(final byte[] origin) {
          * Sets the length.
          *
          * @param length Must be greater or equal to 0.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setLength(final int length) {
             if (length < 0) {
@@ -132,7 +132,7 @@ public Builder setLength(final int length) {
          * Sets the offset.
          *
          * @param offset Must be greater or equal to 0.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setOffset(final int offset) {
             if (offset < 0) {

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

@@ -172,7 +172,7 @@ public Builder setCharset(final String charset) {
          * Sets the HTTP content type.
          *
          * @param httpContentType the HTTP content type.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setHttpContentType(final String httpContentType) {
             this.httpContentType = httpContentType;
@@ -183,7 +183,7 @@ public Builder setHttpContentType(final String httpContentType) {
          * Sets the lenient toggle.
          *
          * @param lenient the lenient toggle.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setLenient(final boolean lenient) {
             this.lenient = lenient;