Javadoc

Author: garydgregory

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() {

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();

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;

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) {

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) {

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() {

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) {

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) {

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) {

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) {