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 573b9e0d9 Javadoc 573b9e0d9 is described below commit 573b9e0d990626f11a481d5dacfac83d489cccfc Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu May 23 09:17:53 2024 -0400 Javadoc --- .../apache/commons/io/build/AbstractStreamBuilder.java | 16 ++++++++-------- .../org/apache/commons/io/input/BoundedInputStream.java | 6 +++--- .../org/apache/commons/io/input/ChecksumInputStream.java | 6 +++--- .../org/apache/commons/io/input/QueueInputStream.java | 2 +- src/main/java/org/apache/commons/io/input/Tailer.java | 2 +- .../io/input/UnsynchronizedByteArrayInputStream.java | 4 ++-- .../org/apache/commons/io/input/XmlStreamReader.java | 4 ++-- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java index 519c2cf08..c8c9fbdea 100644 --- a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java +++ b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java @@ -230,7 +230,7 @@ public abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T * </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 abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T * </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 abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T * </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 @@ public abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T * 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 abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T * </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 abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T * </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 abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T * </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 @@ public abstract class AbstractStreamBuilder<T, B extends AbstractStreamBuilder<T * </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) diff --git a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java index 31767e40c..83431db3a 100644 --- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java +++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java @@ -117,7 +117,7 @@ public class BoundedInputStream extends ProxyInputStream { * </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 class BoundedInputStream extends ProxyInputStream { * </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 class BoundedInputStream extends ProxyInputStream { * * @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; diff --git a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java index edbe2c393..e56ba6670 100644 --- a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java +++ b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java @@ -149,7 +149,7 @@ public final class ChecksumInputStream extends CountingInputStream { * 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 final class ChecksumInputStream extends CountingInputStream { * </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 final class ChecksumInputStream extends CountingInputStream { * 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; diff --git a/src/main/java/org/apache/commons/io/input/QueueInputStream.java b/src/main/java/org/apache/commons/io/input/QueueInputStream.java index d6d9529af..5c816552c 100644 --- a/src/main/java/org/apache/commons/io/input/QueueInputStream.java +++ b/src/main/java/org/apache/commons/io/input/QueueInputStream.java @@ -116,7 +116,7 @@ public class QueueInputStream extends InputStream { * 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) { diff --git a/src/main/java/org/apache/commons/io/input/Tailer.java b/src/main/java/org/apache/commons/io/input/Tailer.java index 19c997759..0c7d8cc2f 100644 --- a/src/main/java/org/apache/commons/io/input/Tailer.java +++ b/src/main/java/org/apache/commons/io/input/Tailer.java @@ -274,7 +274,7 @@ public class Tailer implements Runnable, AutoCloseable { * 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"); diff --git a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java index f9d4c12c4..853281cfa 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java @@ -118,7 +118,7 @@ public class UnsynchronizedByteArrayInputStream extends InputStream { * 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 class UnsynchronizedByteArrayInputStream extends InputStream { * 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) { diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java index 9ae9dcd63..00c21a787 100644 --- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java +++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java @@ -172,7 +172,7 @@ public class XmlStreamReader extends Reader { * 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 class XmlStreamReader extends Reader { * Sets the lenient toggle. * * @param lenient the lenient toggle. - * @return this. + * @return {@code this} instance. */ public Builder setLenient(final boolean lenient) { this.lenient = lenient;