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
commit a478e88a28d9187dba7902890cfb7cb626ba4ecf Author: Gary D. Gregory <[email protected]> AuthorDate: Wed Aug 20 06:55:29 2025 -0400 Javadoc --- .../java/org/apache/commons/io/build/AbstractSupplier.java | 2 +- .../org/apache/commons/io/file/CountingPathVisitor.java | 8 ++++---- .../java/org/apache/commons/io/file/SimplePathVisitor.java | 2 +- .../org/apache/commons/io/input/BoundedInputStream.java | 2 +- .../commons/io/input/BufferedFileChannelInputStream.java | 2 +- .../java/org/apache/commons/io/input/NullInputStream.java | 2 +- .../java/org/apache/commons/io/input/ProxyInputStream.java | 4 ++-- .../org/apache/commons/io/input/ThrottledInputStream.java | 6 +++--- .../commons/io/output/AbstractByteArrayOutputStream.java | 4 ++-- .../org/apache/commons/io/output/ProxyOutputStream.java | 2 +- .../io/serialization/ObjectStreamClassPredicate.java | 14 +++++++------- 11 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/main/java/org/apache/commons/io/build/AbstractSupplier.java b/src/main/java/org/apache/commons/io/build/AbstractSupplier.java index 96de75cb9..0c289877d 100644 --- a/src/main/java/org/apache/commons/io/build/AbstractSupplier.java +++ b/src/main/java/org/apache/commons/io/build/AbstractSupplier.java @@ -140,7 +140,7 @@ public AbstractSupplier() { * (B) this * </pre> * - * @return this instance typed as the subclass type {@code B}. + * @return {@code this} instance typed as the subclass type {@code B}. */ @SuppressWarnings("unchecked") protected B asThis() { diff --git a/src/main/java/org/apache/commons/io/file/CountingPathVisitor.java b/src/main/java/org/apache/commons/io/file/CountingPathVisitor.java index 16f1e2675..ab02ad073 100644 --- a/src/main/java/org/apache/commons/io/file/CountingPathVisitor.java +++ b/src/main/java/org/apache/commons/io/file/CountingPathVisitor.java @@ -80,7 +80,7 @@ PathCounters getPathCounters() { * Sets how to filter directories. * * @param directoryFilter how to filter files. - * @return this instance. + * @return {@code this} instance. */ public B setDirectoryFilter(final PathFilter directoryFilter) { this.directoryFilter = directoryFilter != null ? directoryFilter : defaultDirectoryFilter(); @@ -91,7 +91,7 @@ public B setDirectoryFilter(final PathFilter directoryFilter) { * Sets how to transform directories, defaults to {@link UnaryOperator#identity()}. * * @param directoryTransformer how to filter files. - * @return this instance. + * @return {@code this} instance. */ public B setDirectoryPostTransformer(final UnaryOperator<Path> directoryTransformer) { this.directoryPostTransformer = directoryTransformer != null ? directoryTransformer : defaultDirectoryTransformer(); @@ -102,7 +102,7 @@ public B setDirectoryPostTransformer(final UnaryOperator<Path> directoryTransfor * Sets how to filter files. * * @param fileFilter how to filter files. - * @return this instance. + * @return {@code this} instance. */ public B setFileFilter(final PathFilter fileFilter) { this.fileFilter = fileFilter != null ? fileFilter : defaultFileFilter(); @@ -113,7 +113,7 @@ public B setFileFilter(final PathFilter fileFilter) { * Sets how to count path visits. * * @param pathCounters How to count path visits. - * @return this instance. + * @return {@code this} instance. */ public B setPathCounters(final PathCounters pathCounters) { this.pathCounters = pathCounters != null ? pathCounters : defaultPathCounters(); diff --git a/src/main/java/org/apache/commons/io/file/SimplePathVisitor.java b/src/main/java/org/apache/commons/io/file/SimplePathVisitor.java index 85007c902..3b32cb09c 100644 --- a/src/main/java/org/apache/commons/io/file/SimplePathVisitor.java +++ b/src/main/java/org/apache/commons/io/file/SimplePathVisitor.java @@ -62,7 +62,7 @@ IOBiFunction<Path, IOException, FileVisitResult> getVisitFileFailedFunction() { * </p> * * @param visitFileFailedFunction the function to call on {@link #visitFileFailed(Path, IOException)}. - * @return this instance. + * @return {@code this} instance. */ public B setVisitFileFailedFunction(final IOBiFunction<Path, IOException, FileVisitResult> visitFileFailedFunction) { this.visitFileFailedFunction = visitFileFailedFunction; 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 f6871b481..ce642f866 100644 --- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java +++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java @@ -164,7 +164,7 @@ public T setMaxCount(final long maxCount) { * </p> * * @param onMaxCount the {@link ProxyInputStream#afterRead(int)} behavior. - * @return this instance. + * @return {@code this} instance. * @since 2.18.0 */ public T setOnMaxCount(final IOBiConsumer<Long, Long> onMaxCount) { diff --git a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java index 220b21d61..bc5a95330 100644 --- a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java +++ b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java @@ -115,7 +115,7 @@ public BufferedFileChannelInputStream get() throws IOException { * </p> * * @param fileChannel the file channel. - * @return this instance. + * @return {@code this} instance. * @since 2.18.0 */ public Builder setFileChannel(final FileChannel fileChannel) { diff --git a/src/main/java/org/apache/commons/io/input/NullInputStream.java b/src/main/java/org/apache/commons/io/input/NullInputStream.java index 2b0f751cb..5f3497863 100644 --- a/src/main/java/org/apache/commons/io/input/NullInputStream.java +++ b/src/main/java/org/apache/commons/io/input/NullInputStream.java @@ -186,7 +186,7 @@ private int handleEof() throws IOException { /** * Initializes or re-initializes this instance for reuse. * - * @return this instance. + * @return {@code this} instance. * @since 2.17.0 */ public NullInputStream init() { diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java index a2e382719..6687d008d 100644 --- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java +++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java @@ -88,7 +88,7 @@ public IOIntConsumer getAfterRead() { * </p> * * @param afterRead the {@link ProxyInputStream#afterRead(int)} behavior. - * @return this instance. + * @return {@code this} instance. */ public B setAfterRead(final IOIntConsumer afterRead) { this.afterRead = afterRead; @@ -370,7 +370,7 @@ public synchronized void reset() throws IOException { * Sets the underlying input stream. * * @param in The input stream to set in {@link java.io.FilterInputStream#in}. - * @return this instance. + * @return {@code this} instance. * @since 2.19.0 */ public ProxyInputStream setReference(final InputStream in) { diff --git a/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java b/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java index 9f4d9f01c..b081db3c6 100644 --- a/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java +++ b/src/main/java/org/apache/commons/io/input/ThrottledInputStream.java @@ -130,7 +130,7 @@ public ThrottledInputStream get() throws IOException { * * @param value the maximum bytes * @param chronoUnit a duration scale goal. - * @return this instance. + * @return {@code this} instance. * @throws IllegalArgumentException Thrown if maxBytesPerSecond <= 0. * @since 2.19.0 */ @@ -153,7 +153,7 @@ public Builder setMaxBytes(final long value, final ChronoUnit chronoUnit) { * * @param value the maximum bytes * @param duration a duration goal. - * @return this instance. + * @return {@code this} instance. * @throws IllegalArgumentException Thrown if maxBytesPerSecond <= 0. */ // Consider making public in the future @@ -166,7 +166,7 @@ Builder setMaxBytes(final long value, final Duration duration) { * Sets the maximum bytes per second. * * @param maxBytesPerSecond the maximum bytes per second. - * @return this instance. + * @return {@code this} instance. * @throws IllegalArgumentException Thrown if maxBytesPerSecond <= 0. */ private Builder setMaxBytesPerSecond(final double maxBytesPerSecond) { diff --git a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java index 071aaf408..8bcbe9ae8 100644 --- a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java @@ -110,7 +110,7 @@ public AbstractByteArrayOutputStream() { /** * Returns this instance typed to {@code T}. * - * @return this instance + * @return {@code this} instance */ @SuppressWarnings("unchecked") protected T asThis() { @@ -336,7 +336,7 @@ public void write(final byte b[]) { * * @param data The String to convert to bytes. not null. * @param charset The {@link Charset} o encode the {@code String}, null means the default encoding. - * @return this instance. + * @return {@code this} instance. * @since 2.19.0 */ public T write(final CharSequence data, final Charset charset) { diff --git a/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java b/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java index 1fb6f8ad8..090f2d059 100644 --- a/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java @@ -164,7 +164,7 @@ protected void handleIOException(final IOException e) throws IOException { * Sets the underlying output stream. * * @param out the underlying output stream. - * @return this instance. + * @return {@code this} instance. * @since 2.19.0 */ public ProxyOutputStream setReference(final OutputStream out) { diff --git a/src/main/java/org/apache/commons/io/serialization/ObjectStreamClassPredicate.java b/src/main/java/org/apache/commons/io/serialization/ObjectStreamClassPredicate.java index 1f91b0b0e..5a3375cd7 100644 --- a/src/main/java/org/apache/commons/io/serialization/ObjectStreamClassPredicate.java +++ b/src/main/java/org/apache/commons/io/serialization/ObjectStreamClassPredicate.java @@ -70,7 +70,7 @@ public ObjectStreamClassPredicate accept(final Class<?>... classes) { * </p> * * @param matcher a class name matcher to <em>accept</em> objects. - * @return this instance. + * @return {@code this} instance. */ public ObjectStreamClassPredicate accept(final ClassNameMatcher matcher) { acceptMatchers.add(matcher); @@ -84,7 +84,7 @@ public ObjectStreamClassPredicate accept(final ClassNameMatcher matcher) { * </p> * * @param pattern a Pattern for compiled regular expression. - * @return this instance. + * @return {@code this} instance. */ public ObjectStreamClassPredicate accept(final Pattern pattern) { acceptMatchers.add(new RegexpClassNameMatcher(pattern)); @@ -99,7 +99,7 @@ public ObjectStreamClassPredicate accept(final Pattern pattern) { * * @param patterns Wildcard file name patterns as defined by {@link org.apache.commons.io.FilenameUtils#wildcardMatch(String, String) * FilenameUtils.wildcardMatch} - * @return this instance. + * @return {@code this} instance. */ public ObjectStreamClassPredicate accept(final String... patterns) { Stream.of(patterns).map(WildcardClassNameMatcher::new).forEach(acceptMatchers::add); @@ -113,7 +113,7 @@ public ObjectStreamClassPredicate accept(final String... patterns) { * </p> * * @param classes Classes to reject - * @return this instance. + * @return {@code this} instance. */ public ObjectStreamClassPredicate reject(final Class<?>... classes) { Stream.of(classes).map(c -> new FullClassNameMatcher(c.getName())).forEach(rejectMatchers::add); @@ -127,7 +127,7 @@ public ObjectStreamClassPredicate reject(final Class<?>... classes) { * </p> * * @param m the matcher to use - * @return this instance. + * @return {@code this} instance. */ public ObjectStreamClassPredicate reject(final ClassNameMatcher m) { rejectMatchers.add(m); @@ -141,7 +141,7 @@ public ObjectStreamClassPredicate reject(final ClassNameMatcher m) { * </p> * * @param pattern standard Java regexp - * @return this instance. + * @return {@code this} instance. */ public ObjectStreamClassPredicate reject(final Pattern pattern) { rejectMatchers.add(new RegexpClassNameMatcher(pattern)); @@ -156,7 +156,7 @@ public ObjectStreamClassPredicate reject(final Pattern pattern) { * * @param patterns Wildcard file name patterns as defined by {@link org.apache.commons.io.FilenameUtils#wildcardMatch(String, String) * FilenameUtils.wildcardMatch} - * @return this instance. + * @return {@code this} instance. */ public ObjectStreamClassPredicate reject(final String... patterns) { Stream.of(patterns).map(WildcardClassNameMatcher::new).forEach(rejectMatchers::add);
