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 b27a9d019 No need for blank Javadoc lines between Javadoc @ tags b27a9d019 is described below commit b27a9d01939e101942527ddffacf994a43413b48 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu Nov 28 12:40:09 2024 -0500 No need for blank Javadoc lines between Javadoc @ tags --- src/main/java/org/apache/commons/io/FileSystem.java | 2 -- src/main/java/org/apache/commons/io/HexDump.java | 5 ----- src/main/java/org/apache/commons/io/IOUtils.java | 3 --- .../java/org/apache/commons/io/UncheckedIOExceptions.java | 1 - .../java/org/apache/commons/io/file/DeletingPathVisitor.java | 1 - src/main/java/org/apache/commons/io/file/PathUtils.java | 7 ------- .../java/org/apache/commons/io/file/attribute/FileTimes.java | 1 - .../org/apache/commons/io/filefilter/FileFilterUtils.java | 12 ------------ .../apache/commons/io/filefilter/MagicNumberFileFilter.java | 4 ---- .../java/org/apache/commons/io/filefilter/OrFileFilter.java | 1 - .../java/org/apache/commons/io/function/IOBiConsumer.java | 1 - .../java/org/apache/commons/io/function/IOBiFunction.java | 1 - .../org/apache/commons/io/function/IOBinaryOperator.java | 1 - .../java/org/apache/commons/io/function/IOComparator.java | 1 - src/main/java/org/apache/commons/io/function/IOFunction.java | 8 -------- .../java/org/apache/commons/io/function/IOQuadFunction.java | 1 - .../java/org/apache/commons/io/function/IOTriConsumer.java | 1 - .../java/org/apache/commons/io/function/IOTriFunction.java | 1 - .../java/org/apache/commons/io/function/IOUnaryOperator.java | 1 - .../org/apache/commons/io/input/UncheckedBufferedReader.java | 1 - .../commons/io/input/UnsynchronizedByteArrayInputStream.java | 2 -- .../java/org/apache/commons/io/input/XmlStreamReader.java | 1 - .../commons/io/monitor/FileAlterationListenerAdaptor.java | 1 - .../commons/io/output/AbstractByteArrayOutputStream.java | 1 - .../org/apache/commons/io/output/AppendableOutputStream.java | 1 - .../java/org/apache/commons/io/output/AppendableWriter.java | 1 - .../org/apache/commons/io/output/ChunkedOutputStream.java | 1 - .../java/org/apache/commons/io/output/ChunkedWriter.java | 1 - .../apache/commons/io/output/DeferredFileOutputStream.java | 1 - .../apache/commons/io/output/ThresholdingOutputStream.java | 5 ----- .../java/org/apache/commons/io/FileUtilsFileNewerTest.java | 2 -- src/test/java/org/apache/commons/io/LineIteratorTest.java | 3 --- src/test/java/org/apache/commons/io/file/DeletablePath.java | 1 - 33 files changed, 75 deletions(-) diff --git a/src/main/java/org/apache/commons/io/FileSystem.java b/src/main/java/org/apache/commons/io/FileSystem.java index 566389f93..8d6381d48 100644 --- a/src/main/java/org/apache/commons/io/FileSystem.java +++ b/src/main/java/org/apache/commons/io/FileSystem.java @@ -350,7 +350,6 @@ public enum FileSystem { /** * Gets the file allocation block size in bytes. * @return the file allocation block size in bytes. - * * @since 2.12.0 */ public int getBlockSize() { @@ -402,7 +401,6 @@ public enum FileSystem { * Gets the name separator, '\\' on Windows, '/' on Linux. * * @return '\\' on Windows, '/' on Linux. - * * @since 2.12.0 */ public char getNameSeparator() { diff --git a/src/main/java/org/apache/commons/io/HexDump.java b/src/main/java/org/apache/commons/io/HexDump.java index e747be6d6..2a463726f 100644 --- a/src/main/java/org/apache/commons/io/HexDump.java +++ b/src/main/java/org/apache/commons/io/HexDump.java @@ -64,11 +64,9 @@ public class HexDump { * * @param data the byte array to be dumped * @param appendable the Appendable to which the data is to be written - * * @throws IOException is thrown if anything goes wrong writing * the data to appendable * @throws NullPointerException if the output appendable is null - * * @since 2.12.0 */ public static void dump(final byte[] data, final Appendable appendable) @@ -96,13 +94,11 @@ public class HexDump { * @param appendable the Appendable to which the data is to be written * @param index initial index into the byte array * @param length number of bytes to dump from the array - * * @throws IOException is thrown if anything goes wrong writing * the data to appendable * @throws ArrayIndexOutOfBoundsException if the index or length is * outside the data array's bounds * @throws NullPointerException if the output appendable is null - * * @since 2.12.0 */ public static void dump(final byte[] data, final long offset, @@ -178,7 +174,6 @@ public class HexDump { * @param stream the OutputStream to which the data is to be * written * @param index initial index into the byte array - * * @throws IOException is thrown if anything goes wrong writing * the data to stream * @throws ArrayIndexOutOfBoundsException if the index is diff --git a/src/main/java/org/apache/commons/io/IOUtils.java b/src/main/java/org/apache/commons/io/IOUtils.java index 2c420d070..db2223046 100644 --- a/src/main/java/org/apache/commons/io/IOUtils.java +++ b/src/main/java/org/apache/commons/io/IOUtils.java @@ -513,7 +513,6 @@ public class IOUtils { * * @param closeable the objects to close, may be null or already closed * @since 2.0 - * * @see Throwable#addSuppressed(Throwable) */ public static void closeQuietly(final Closeable closeable) { @@ -2043,7 +2042,6 @@ public class IOUtils { * * @param input where to read input from * @param buffer destination - * * @throws IOException if there is a problem reading the file * @throws IllegalArgumentException if length is negative * @throws EOFException if the number of bytes read was incorrect @@ -2064,7 +2062,6 @@ public class IOUtils { * @param buffer destination * @param offset initial offset into buffer * @param length length to read, must be >= 0 - * * @throws IOException if there is a problem reading the file * @throws IllegalArgumentException if length is negative * @throws EOFException if the number of bytes read was incorrect diff --git a/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java b/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java index 97271af6c..8fdb8aaf7 100644 --- a/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java +++ b/src/main/java/org/apache/commons/io/UncheckedIOExceptions.java @@ -49,7 +49,6 @@ final class UncheckedIOExceptions { * </p> * @param e cause the {@link IOException}. * @param message the detail message. - * * @return a new {@link UncheckedIOException}. */ public static UncheckedIOException wrap(final IOException e, final Object message) { diff --git a/src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java b/src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java index 53dc0db14..26a1d4d78 100644 --- a/src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java +++ b/src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java @@ -93,7 +93,6 @@ public class DeletingPathVisitor extends CountingPathVisitor { * Constructs a instance that deletes files except for the files and directories explicitly given. * * @param pathCounter How to count visits. - * * @param skip The files to skip deleting. */ public DeletingPathVisitor(final PathCounters pathCounter, final String... skip) { diff --git a/src/main/java/org/apache/commons/io/file/PathUtils.java b/src/main/java/org/apache/commons/io/file/PathUtils.java index b93535d32..e7ee8ba9c 100644 --- a/src/main/java/org/apache/commons/io/file/PathUtils.java +++ b/src/main/java/org/apache/commons/io/file/PathUtils.java @@ -406,7 +406,6 @@ public final class PathUtils { * Gets the current directory. * * @return the current directory. - * * @since 2.9.0 */ public static Path current() { @@ -800,11 +799,9 @@ public final class PathUtils { * * @param filter the filter to apply to the set of files. * @param paths the array of files to apply the filter to. - * * @return a subset of {@code files} that is accepted by the file filter. * @throws NullPointerException if the filter is {@code null} * @throws IllegalArgumentException if {@code files} contains a {@code null} value. - * * @since 2.9.0 */ public static Path[] filter(final PathFilter filter, final Path... paths) { @@ -1721,7 +1718,6 @@ public final class PathUtils { * @param directory See {@link Files#walkFileTree(Path,FileVisitor)}. * @param <T> See {@link Files#walkFileTree(Path,FileVisitor)}. * @return the given visitor. - * * @throws NoSuchFileException if the directory does not exist. * @throws IOException if an I/O error is thrown by a visitor method. * @throws NullPointerException if the directory is {@code null}. @@ -1742,7 +1738,6 @@ public final class PathUtils { * @param visitor See {@link Files#walkFileTree(Path,Set,int,FileVisitor)}. * @param <T> See {@link Files#walkFileTree(Path,Set,int,FileVisitor)}. * @return the given visitor. - * * @throws IOException if an I/O error is thrown by a visitor method. */ public static <T extends FileVisitor<? super Path>> T visitFileTree(final T visitor, final Path start, final Set<FileVisitOption> options, @@ -1761,7 +1756,6 @@ public final class PathUtils { * @param more See {@link Paths#get(String,String[])}. * @param <T> See {@link Files#walkFileTree(Path,FileVisitor)}. * @return the given visitor. - * * @throws IOException if an I/O error is thrown by a visitor method. */ public static <T extends FileVisitor<? super Path>> T visitFileTree(final T visitor, final String first, final String... more) throws IOException { @@ -1777,7 +1771,6 @@ public final class PathUtils { * @param uri See {@link Paths#get(URI)}. * @param <T> See {@link Files#walkFileTree(Path,FileVisitor)}. * @return the given visitor. - * * @throws IOException if an I/O error is thrown by a visitor method. */ public static <T extends FileVisitor<? super Path>> T visitFileTree(final T visitor, final URI uri) throws IOException { diff --git a/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java b/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java index e899b65d4..3ab11d48f 100644 --- a/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java +++ b/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java @@ -157,7 +157,6 @@ public final class FileTimes { * * @param ntfsTime the NTFS time in 100-nanosecond units * @return the FileTime - * * @see #toNtfsTime(FileTime) */ public static FileTime ntfsTimeToFileTime(final long ntfsTime) { diff --git a/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java b/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java index 4eed282ba..0fd7bd64d 100644 --- a/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java +++ b/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java @@ -136,7 +136,6 @@ public class FileFilterUtils { * * @param filters the IOFileFilters that will be ANDed together. * @return a filter that ANDs the specified filters - * * @throws IllegalArgumentException if the filters are null or contain a * null value. * @see AndFileFilter @@ -229,7 +228,6 @@ public class FileFilterUtils { * </pre> * @param filter the filter to apply to the set of files. * @param files the array of files to apply the filter to. - * * @return a subset of {@code files} that is accepted by the * file filter. * @throws NullPointerException if the filter is {@code null} @@ -263,7 +261,6 @@ public class FileFilterUtils { * </pre> * @param filter the filter to apply to the set of files. * @param files the array of files to apply the filter to. - * * @return a subset of {@code files} that is accepted by the * file filter. * @throws IllegalArgumentException if the filter is {@code null} @@ -283,7 +280,6 @@ public class FileFilterUtils { * @param filter the filter to apply to the stream of files. * @param stream the stream of files on which to apply the filter. * @param collector how to collect the end result. - * * @param <R> the return type. * @param <A> the mutable accumulation type of the reduction operation (often hidden as an implementation detail) * @return a subset of files from the stream that is accepted by the filter. @@ -317,7 +313,6 @@ public class FileFilterUtils { * </pre> * @param filter the filter to apply to each files in the list. * @param files the collection of files to apply the filter to. - * * @return a subset of {@code files} that is accepted by the * file filter. * @throws IllegalArgumentException if the filter is {@code null} @@ -346,7 +341,6 @@ public class FileFilterUtils { * </pre> * @param filter the filter to apply to each files in the list. * @param files the collection of files to apply the filter to. - * * @return a subset of {@code files} that is accepted by the * file filter. * @throws IllegalArgumentException if the filter is {@code null} @@ -377,7 +371,6 @@ public class FileFilterUtils { * </pre> * @param filter the filter to apply to the set of files. * @param files the collection of files to apply the filter to. - * * @return a subset of {@code files} that is accepted by the * file filter. * @throws IllegalArgumentException if the filter is {@code null} @@ -407,11 +400,9 @@ public class FileFilterUtils { * </pre> * @param filter the filter to apply to the set of files. * @param files the collection of files to apply the filter to. - * * @return a subset of {@code files} that is accepted by the * file filter. * @throws IllegalArgumentException if the filter is {@code null} - * * @since 2.0 */ public static Set<File> filterSet(final IOFileFilter filter, final Iterable<File> files) { @@ -447,7 +438,6 @@ public class FileFilterUtils { * @param magicNumber the magic number (byte sequence) to match at the * provided offset in each file. * @param offset the offset within the files to look for the magic number. - * * @return an IOFileFilter that accepts files containing the magic number * at the specified offset. * @@ -487,7 +477,6 @@ public class FileFilterUtils { * @param magicNumber the magic number (byte sequence) to match at the * provided offset in each file. * @param offset the offset within the files to look for the magic number. - * * @return an IOFileFilter that accepts files containing the magic number * at the specified offset. * @@ -597,7 +586,6 @@ public class FileFilterUtils { * * @param filters the IOFileFilters that will be ORed together. * @return a filter that ORs the specified filters - * * @throws IllegalArgumentException if the filters are null or contain a * null value. * @see OrFileFilter diff --git a/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java index 6956bc8d2..70e4d18d9 100644 --- a/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java @@ -139,7 +139,6 @@ public class MagicNumberFileFilter extends AbstractFileFilter implements Seriali * </pre> * * @param magicNumber the magic number to look for in the file. - * * @throws IllegalArgumentException if {@code magicNumber} is * {@code null}, or contains no bytes. */ @@ -166,7 +165,6 @@ public class MagicNumberFileFilter extends AbstractFileFilter implements Seriali * * @param magicNumbers the magic number to look for in the file. * @param offset the byte offset in the file to start comparing bytes. - * * @throws IllegalArgumentException if {@code magicNumber} * contains no bytes, or {@code offset} * is a negative number. @@ -224,7 +222,6 @@ public class MagicNumberFileFilter extends AbstractFileFilter implements Seriali * @param magicNumber the magic number to look for in the file. * The string is converted to bytes using the platform default charset. * @param offset the byte offset in the file to start comparing bytes. - * * @throws IllegalArgumentException if {@code magicNumber} is * the empty String, or {@code offset} is * a negative number. @@ -254,7 +251,6 @@ public class MagicNumberFileFilter extends AbstractFileFilter implements Seriali * </p> * * @param file the file to accept or reject. - * * @return {@code true} if the file contains the filter's magic number * at the specified offset, {@code false} otherwise. */ diff --git a/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java index 4c6e82a09..10999505e 100644 --- a/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/OrFileFilter.java @@ -77,7 +77,6 @@ public class OrFileFilter extends AbstractFileFilter implements ConditionalFileF /** * Constructs a new instance for the give filters. * @param fileFilters filters to OR. - * * @since 2.9.0 */ public OrFileFilter(final IOFileFilter... fileFilters) { diff --git a/src/main/java/org/apache/commons/io/function/IOBiConsumer.java b/src/main/java/org/apache/commons/io/function/IOBiConsumer.java index 9600f8023..d2971d0f2 100644 --- a/src/main/java/org/apache/commons/io/function/IOBiConsumer.java +++ b/src/main/java/org/apache/commons/io/function/IOBiConsumer.java @@ -27,7 +27,6 @@ import java.util.function.BiConsumer; * * @param <T> the type of the first argument to the operation * @param <U> the type of the second argument to the operation - * * @see BiConsumer * @since 2.12.0 */ diff --git a/src/main/java/org/apache/commons/io/function/IOBiFunction.java b/src/main/java/org/apache/commons/io/function/IOBiFunction.java index 0231630f0..5cb9c7860 100644 --- a/src/main/java/org/apache/commons/io/function/IOBiFunction.java +++ b/src/main/java/org/apache/commons/io/function/IOBiFunction.java @@ -34,7 +34,6 @@ import java.util.function.Function; * @param <T> the type of the first argument to the function * @param <U> the type of the second argument to the function * @param <R> the type of the result of the function - * * @see Function * @since 2.12.0 */ diff --git a/src/main/java/org/apache/commons/io/function/IOBinaryOperator.java b/src/main/java/org/apache/commons/io/function/IOBinaryOperator.java index 5680d30ae..93884f5c4 100644 --- a/src/main/java/org/apache/commons/io/function/IOBinaryOperator.java +++ b/src/main/java/org/apache/commons/io/function/IOBinaryOperator.java @@ -26,7 +26,6 @@ import java.util.function.BinaryOperator; * Like {@link BinaryOperator} but throws {@link IOException}. * * @param <T> the type of the operands and result of the operator. - * * @see IOBiFunction * @see BinaryOperator * @since 2.12.0 diff --git a/src/main/java/org/apache/commons/io/function/IOComparator.java b/src/main/java/org/apache/commons/io/function/IOComparator.java index 01a5132c5..2c52af877 100644 --- a/src/main/java/org/apache/commons/io/function/IOComparator.java +++ b/src/main/java/org/apache/commons/io/function/IOComparator.java @@ -25,7 +25,6 @@ import java.util.Comparator; * Like {@link Comparator} but throws {@link IOException}. * * @param <T> the type of objects that may be compared by this comparator - * * @see Comparator * @since 2.12.0 */ diff --git a/src/main/java/org/apache/commons/io/function/IOFunction.java b/src/main/java/org/apache/commons/io/function/IOFunction.java index 8ab106516..a2133652c 100644 --- a/src/main/java/org/apache/commons/io/function/IOFunction.java +++ b/src/main/java/org/apache/commons/io/function/IOFunction.java @@ -53,7 +53,6 @@ public interface IOFunction<T, R> { * @param after the consumer to apply after this function is applied * @return a composed function that first applies this function and then applies the {@code after} consumer * @throws NullPointerException if after is null - * * @see #compose(IOFunction) */ default IOConsumer<T> andThen(final Consumer<? super R> after) { @@ -70,7 +69,6 @@ public interface IOFunction<T, R> { * @param after the function to apply after this function is applied * @return a composed function that first applies this function and then applies the {@code after} function * @throws NullPointerException if after is null - * * @see #compose(IOFunction) */ default <V> IOFunction<T, V> andThen(final Function<? super R, ? extends V> after) { @@ -86,7 +84,6 @@ public interface IOFunction<T, R> { * @param after the consumer to apply after this function is applied * @return a composed function that first applies this function and then applies the {@code after} consumer * @throws NullPointerException if after is null - * * @see #compose(IOFunction) */ default IOConsumer<T> andThen(final IOConsumer<? super R> after) { @@ -103,7 +100,6 @@ public interface IOFunction<T, R> { * @param after the function to apply after this function is applied * @return a composed function that first applies this function and then applies the {@code after} function * @throws NullPointerException if after is null - * * @see #compose(IOFunction) */ default <V> IOFunction<T, V> andThen(final IOFunction<? super R, ? extends V> after) { @@ -139,7 +135,6 @@ public interface IOFunction<T, R> { * @param before the function to apply before this function is applied * @return a composed function that first applies the {@code before} function and then applies this function * @throws NullPointerException if before is null - * * @see #andThen(IOFunction) */ default <V> IOFunction<V, R> compose(final Function<? super V, ? extends T> before) { @@ -156,7 +151,6 @@ public interface IOFunction<T, R> { * @param before the function to apply before this function is applied * @return a composed function that first applies the {@code before} function and then applies this function * @throws NullPointerException if before is null - * * @see #andThen(IOFunction) */ default <V> IOFunction<V, R> compose(final IOFunction<? super V, ? extends T> before) { @@ -172,7 +166,6 @@ public interface IOFunction<T, R> { * @param before the supplier which feeds the application of this function * @return a composed function that first applies the {@code before} function and then applies this function * @throws NullPointerException if before is null - * * @see #andThen(IOFunction) */ default IOSupplier<R> compose(final IOSupplier<? extends T> before) { @@ -188,7 +181,6 @@ public interface IOFunction<T, R> { * @param before the supplier which feeds the application of this function * @return a composed function that first applies the {@code before} function and then applies this function * @throws NullPointerException if before is null - * * @see #andThen(IOFunction) */ default IOSupplier<R> compose(final Supplier<? extends T> before) { diff --git a/src/main/java/org/apache/commons/io/function/IOQuadFunction.java b/src/main/java/org/apache/commons/io/function/IOQuadFunction.java index 161fe6e68..086901649 100644 --- a/src/main/java/org/apache/commons/io/function/IOQuadFunction.java +++ b/src/main/java/org/apache/commons/io/function/IOQuadFunction.java @@ -34,7 +34,6 @@ import java.util.function.Function; * @param <V> the type of the third argument to the function * @param <W> the type of the fourth argument to the function * @param <R> the type of the result of the function - * * @see Function * @since 2.12.0 */ diff --git a/src/main/java/org/apache/commons/io/function/IOTriConsumer.java b/src/main/java/org/apache/commons/io/function/IOTriConsumer.java index 0de0a2c4d..c53e87d09 100644 --- a/src/main/java/org/apache/commons/io/function/IOTriConsumer.java +++ b/src/main/java/org/apache/commons/io/function/IOTriConsumer.java @@ -27,7 +27,6 @@ import java.util.function.BiConsumer; * @param <T> the type of the first argument to the operation * @param <U> the type of the second argument to the operation * @param <V> the type of the third argument to the operation - * * @see BiConsumer * @since 2.12.0 */ diff --git a/src/main/java/org/apache/commons/io/function/IOTriFunction.java b/src/main/java/org/apache/commons/io/function/IOTriFunction.java index ddd3b2103..b61375973 100644 --- a/src/main/java/org/apache/commons/io/function/IOTriFunction.java +++ b/src/main/java/org/apache/commons/io/function/IOTriFunction.java @@ -33,7 +33,6 @@ import java.util.function.Function; * @param <U> the type of the second argument to the function * @param <V> the type of the third argument to the function * @param <R> the type of the result of the function - * * @see Function * @since 2.12.0 */ diff --git a/src/main/java/org/apache/commons/io/function/IOUnaryOperator.java b/src/main/java/org/apache/commons/io/function/IOUnaryOperator.java index cf6445d55..f777f915c 100644 --- a/src/main/java/org/apache/commons/io/function/IOUnaryOperator.java +++ b/src/main/java/org/apache/commons/io/function/IOUnaryOperator.java @@ -25,7 +25,6 @@ import java.util.function.UnaryOperator; * Like {@link UnaryOperator} but throws {@link IOException}. * * @param <T> the type of the operand and result of the operator. - * * @see UnaryOperator * @see IOFunction * @since 2.12.0 diff --git a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java index a8b46b791..052c20a7f 100644 --- a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java +++ b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java @@ -112,7 +112,6 @@ public final class UncheckedBufferedReader extends BufferedReader { * * @param reader A Reader * @param bufferSize Input-buffer size - * * @throws IllegalArgumentException If {@code bufferSize <= 0} */ private UncheckedBufferedReader(final Reader reader, final int bufferSize) { 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 e351baad6..49a22bd27 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java @@ -208,7 +208,6 @@ public class UnsynchronizedByteArrayInputStream extends InputStream { * * @param data the buffer * @param offset the offset into the buffer - * * @throws IllegalArgumentException if the offset is less than zero * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @@ -223,7 +222,6 @@ public class UnsynchronizedByteArrayInputStream extends InputStream { * @param data the buffer * @param offset the offset into the buffer * @param length the length of the buffer - * * @throws IllegalArgumentException if the offset or length less than zero * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ 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 00c21a787..5e33c89c2 100644 --- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java +++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java @@ -694,7 +694,6 @@ public class XmlStreamReader extends Reader { * @param xmlEnc XML encoding * @param lenient indicates if the charset encoding detection should be relaxed. * @param httpContentType The HTTP content type - * * @return the HTTP encoding * @throws IOException thrown if there is a problem reading the stream. */ diff --git a/src/main/java/org/apache/commons/io/monitor/FileAlterationListenerAdaptor.java b/src/main/java/org/apache/commons/io/monitor/FileAlterationListenerAdaptor.java index 32633eb99..1204b44fb 100644 --- a/src/main/java/org/apache/commons/io/monitor/FileAlterationListenerAdaptor.java +++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationListenerAdaptor.java @@ -22,7 +22,6 @@ import java.io.File; * Convenience {@link FileAlterationListener} implementation that does nothing. * * @see FileAlterationObserver - * * @since 2.0 */ public class FileAlterationListenerAdaptor implements FileAlterationListener { 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 236116e48..256be191e 100644 --- a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java @@ -73,7 +73,6 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream { * @param buffer the buffer * @param offset the offset into the buffer * @param length the length of the buffer - * * @return the InputStream subclass. */ T construct(final byte[] buffer, final int offset, final int length); diff --git a/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java b/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java index 40489a95c..7030d29ce 100644 --- a/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java @@ -30,7 +30,6 @@ import java.io.Writer; * * @since 2.5 * @see Appendable - * * @param <T> The type of the {@link Appendable} wrapped by this AppendableOutputStream. */ public class AppendableOutputStream <T extends Appendable> extends OutputStream { diff --git a/src/main/java/org/apache/commons/io/output/AppendableWriter.java b/src/main/java/org/apache/commons/io/output/AppendableWriter.java index e887adf63..213126f13 100644 --- a/src/main/java/org/apache/commons/io/output/AppendableWriter.java +++ b/src/main/java/org/apache/commons/io/output/AppendableWriter.java @@ -30,7 +30,6 @@ import java.util.Objects; * * @since 2.7 * @see Appendable - * * @param <T> The type of the {@link Appendable} wrapped by this AppendableWriter. */ public class AppendableWriter <T extends Appendable> extends Writer { diff --git a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java index 43de79220..c6d464313 100644 --- a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java @@ -141,7 +141,6 @@ public class ChunkedOutputStream extends FilterOutputStream { * @param data the data to write * @param srcOffset the offset * @param length the length of data to write - * * @throws IOException if an I/O error occurs. */ @Override diff --git a/src/main/java/org/apache/commons/io/output/ChunkedWriter.java b/src/main/java/org/apache/commons/io/output/ChunkedWriter.java index 5e003f41d..e9bd3aaa6 100644 --- a/src/main/java/org/apache/commons/io/output/ChunkedWriter.java +++ b/src/main/java/org/apache/commons/io/output/ChunkedWriter.java @@ -70,7 +70,6 @@ public class ChunkedWriter extends FilterWriter { * @param data The data * @param srcOffset the offset * @param length the number of bytes to write - * * @throws IOException upon error */ @Override diff --git a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java index 9599edc8c..73de7c9ea 100644 --- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java @@ -461,7 +461,6 @@ public class DeferredFileOutputStream extends ThresholdingOutputStream { * @return the current contents of this output stream. * @throws IOException if this stream is not yet closed or an error occurs. * @see org.apache.commons.io.output.ByteArrayOutputStream#toInputStream() - * * @since 2.9.0 */ public InputStream toInputStream() throws IOException { diff --git a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java index c0bf60133..fa5d285b1 100644 --- a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java @@ -100,7 +100,6 @@ public class ThresholdingOutputStream extends OutputStream { * so, triggers an event to allow a concrete implementation to take action on this. * * @param count The number of bytes about to be written to the underlying output stream. - * * @throws IOException if an error occurs. */ protected void checkThreshold(final int count) throws IOException { @@ -203,7 +202,6 @@ public class ThresholdingOutputStream extends OutputStream { * Sets the byteCount to count. Useful for re-opening an output stream that has previously been written to. * * @param count The number of bytes that have already been written to the output stream - * * @since 2.5 */ protected void setByteCount(final long count) { @@ -224,7 +222,6 @@ public class ThresholdingOutputStream extends OutputStream { * Writes {@code b.length} bytes from the specified byte array to this output stream. * * @param b The array of bytes to be written. - * * @throws IOException if an error occurs. */ @SuppressWarnings("resource") // the underlying stream is managed by a subclass. @@ -242,7 +239,6 @@ public class ThresholdingOutputStream extends OutputStream { * @param b The byte array from which the data will be written. * @param off The start offset in the byte array. * @param len The number of bytes to write. - * * @throws IOException if an error occurs. */ @SuppressWarnings("resource") // the underlying stream is managed by a subclass. @@ -260,7 +256,6 @@ public class ThresholdingOutputStream extends OutputStream { * Writes the specified byte to this output stream. * * @param b The byte to be written. - * * @throws IOException if an error occurs. */ @SuppressWarnings("resource") // the underlying stream is managed by a subclass. diff --git a/src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java b/src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java index 933e9bec9..07eb84973 100644 --- a/src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java +++ b/src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java @@ -69,7 +69,6 @@ public class FileUtilsFileNewerTest { * Tests the {@code isFileNewer(File, *)} methods which a "normal" file. * * @throws IOException - * * @see FileUtils#isFileNewer(File, long) * @see FileUtils#isFileNewer(File, Date) * @see FileUtils#isFileNewer(File, File) @@ -121,7 +120,6 @@ public class FileUtilsFileNewerTest { * Tests the {@code isFileNewer(File, *)} methods which a not existing file. * * @throws IOException if an I/O error occurs. - * * @see FileUtils#isFileNewer(File, long) * @see FileUtils#isFileNewer(File, Date) * @see FileUtils#isFileNewer(File, File) diff --git a/src/test/java/org/apache/commons/io/LineIteratorTest.java b/src/test/java/org/apache/commons/io/LineIteratorTest.java index 9b02cf591..edffe378a 100644 --- a/src/test/java/org/apache/commons/io/LineIteratorTest.java +++ b/src/test/java/org/apache/commons/io/LineIteratorTest.java @@ -65,7 +65,6 @@ public class LineIteratorTest { * * @param file target file * @param lineCount number of lines to create - * * @throws IOException If an I/O error occurs */ private List<String> createLinesFile(final File file, final int lineCount) throws IOException { @@ -80,7 +79,6 @@ public class LineIteratorTest { * @param file target file * @param encoding the encoding to use while writing the lines * @param lineCount number of lines to create - * * @throws IOException If an I/O error occurs */ private List<String> createLinesFile(final File file, final String encoding, final int lineCount) throws IOException { @@ -107,7 +105,6 @@ public class LineIteratorTest { * Utility method to create and test a file with a specified number of lines. * * @param lineCount the lines to create in the test file - * * @throws IOException If an I/O error occurs while creating the file */ private void doTestFileWithSpecifiedLines(final int lineCount) throws IOException { diff --git a/src/test/java/org/apache/commons/io/file/DeletablePath.java b/src/test/java/org/apache/commons/io/file/DeletablePath.java index e998dc094..e884a5e46 100644 --- a/src/test/java/org/apache/commons/io/file/DeletablePath.java +++ b/src/test/java/org/apache/commons/io/file/DeletablePath.java @@ -57,7 +57,6 @@ public class DeletablePath extends AbstractPathWrapper implements Closeable { /** * Deletes the delegate path. * @param deleteOptions How to handle deletion. - * * @return The visitor used to delete the given directory. * @throws IOException if an I/O error is thrown by a visitor method or if an I/O error occurs. */