Skip to content

Commit

Permalink
No need for blank Javadoc lines between Javadoc @ tags
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Nov 28, 2024
1 parent 024e4b6 commit b27a9d0
Show file tree
Hide file tree
Showing 33 changed files with 0 additions and 75 deletions.
2 changes: 0 additions & 2 deletions src/main/java/org/apache/commons/io/FileSystem.java
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,6 @@ private static String replace(final String path, final char oldChar, final char
/**
* Gets the file allocation block size in bytes.
* @return the file allocation block size in bytes.
*
* @since 2.12.0
*/
public int getBlockSize() {
Expand Down Expand Up @@ -402,7 +401,6 @@ public int getMaxPathLength() {
* Gets the name separator, '\\' on Windows, '/' on Linux.
*
* @return '\\' on Windows, '/' on Linux.
*
* @since 2.12.0
*/
public char getNameSeparator() {
Expand Down
5 changes: 0 additions & 5 deletions src/main/java/org/apache/commons/io/HexDump.java
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -96,13 +94,11 @@ public static void dump(final byte[] data, final Appendable appendable)
* @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,
Expand Down Expand Up @@ -178,7 +174,6 @@ public static void dump(final byte[] data, final long offset,
* @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
Expand Down
3 changes: 0 additions & 3 deletions src/main/java/org/apache/commons/io/IOUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,6 @@ private static void closeQ(final Closeable closeable) {
*
* @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) {
Expand Down Expand Up @@ -2043,7 +2042,6 @@ public static int read(final Reader reader, final char[] buffer, final int offse
*
* @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
Expand All @@ -2064,7 +2062,6 @@ public static void readFully(final InputStream input, final byte[] buffer) throw
* @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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ public static UncheckedIOException create(final Object message) {
* </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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ public DeletingPathVisitor(final PathCounters pathCounter, final LinkOption[] li
* 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) {
Expand Down
7 changes: 0 additions & 7 deletions src/main/java/org/apache/commons/io/file/PathUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,6 @@ public static Path createParentDirectories(final Path path, final LinkOption lin
* Gets the current directory.
*
* @return the current directory.
*
* @since 2.9.0
*/
public static Path current() {
Expand Down Expand Up @@ -800,11 +799,9 @@ public static boolean fileContentEquals(final Path path1, final Path path2, fina
*
* @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) {
Expand Down Expand Up @@ -1721,7 +1718,6 @@ public static Path touch(final Path file) throws IOException {
* @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}.
Expand All @@ -1742,7 +1738,6 @@ public static <T extends FileVisitor<? super Path>> T visitFileTree(final T visi
* @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,
Expand All @@ -1761,7 +1756,6 @@ public static <T extends FileVisitor<? super Path>> T visitFileTree(final T visi
* @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 {
Expand All @@ -1777,7 +1771,6 @@ public static <T extends FileVisitor<? super Path>> T visitFileTree(final T visi
* @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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,6 @@ public static Date ntfsTimeToDate(final long ntfsTime) {
*
* @param ntfsTime the NTFS time in 100-nanosecond units
* @return the FileTime
*
* @see #toNtfsTime(FileTime)
*/
public static FileTime ntfsTimeToFileTime(final long ntfsTime) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,6 @@ public static IOFileFilter ageFileFilter(final long cutoffMillis, final boolean
*
* @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
Expand Down Expand Up @@ -229,7 +228,6 @@ public static IOFileFilter fileFileFilter() {
* </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}
Expand Down Expand Up @@ -263,7 +261,6 @@ public static File[] filter(final IOFileFilter filter, final File... files) {
* </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}
Expand All @@ -283,7 +280,6 @@ public static File[] filter(final IOFileFilter filter, final Iterable<File> file
* @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.
Expand Down Expand Up @@ -317,7 +313,6 @@ private static <R, A> R filterFiles(final IOFileFilter filter, final Stream<File
* </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}
Expand Down Expand Up @@ -346,7 +341,6 @@ public static List<File> filterList(final IOFileFilter filter, final File... fil
* </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}
Expand Down Expand Up @@ -377,7 +371,6 @@ public static List<File> filterList(final IOFileFilter filter, final Iterable<Fi
* </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}
Expand Down Expand Up @@ -407,11 +400,9 @@ public static Set<File> filterSet(final IOFileFilter filter, final File... files
* </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) {
Expand Down Expand Up @@ -447,7 +438,6 @@ public static IOFileFilter magicNumberFileFilter(final byte[] magicNumber) {
* @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.
*
Expand Down Expand Up @@ -487,7 +477,6 @@ public static IOFileFilter magicNumberFileFilter(final String magicNumber) {
* @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.
*
Expand Down Expand Up @@ -597,7 +586,6 @@ public static IOFileFilter notFileFilter(final IOFileFilter filter) {
*
* @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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand All @@ -166,7 +165,6 @@ public MagicNumberFileFilter(final byte[] magicNumber) {
*
* @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.
Expand Down Expand Up @@ -224,7 +222,6 @@ public MagicNumberFileFilter(final String magicNumber) {
* @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.
Expand Down Expand Up @@ -254,7 +251,6 @@ public MagicNumberFileFilter(final String magicNumber, final long offset) {
* </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.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ private OrFileFilter(final int initialCapacity) {
/**
* Constructs a new instance for the give filters.
* @param fileFilters filters to OR.
*
* @since 2.9.0
*/
public OrFileFilter(final IOFileFilter... fileFilters) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
*
* @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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
* @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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
* 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
* 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
*/
Expand Down
8 changes: 0 additions & 8 deletions src/main/java/org/apache/commons/io/function/IOFunction.java
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ static <T> IOFunction<T, T> identity() {
* @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) {
Expand All @@ -70,7 +69,6 @@ default IOConsumer<T> andThen(final Consumer<? super R> after) {
* @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) {
Expand All @@ -86,7 +84,6 @@ default <V> IOFunction<T, V> andThen(final Function<? super R, ? extends V> afte
* @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) {
Expand All @@ -103,7 +100,6 @@ default IOConsumer<T> andThen(final IOConsumer<? super R> after) {
* @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) {
Expand Down Expand Up @@ -139,7 +135,6 @@ default Function<T, R> asFunction() {
* @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) {
Expand All @@ -156,7 +151,6 @@ default <V> IOFunction<V, R> compose(final Function<? super V, ? extends T> befo
* @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) {
Expand All @@ -172,7 +166,6 @@ default <V> IOFunction<V, R> compose(final IOFunction<? super V, ? extends T> be
* @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) {
Expand All @@ -188,7 +181,6 @@ default IOSupplier<R> compose(final IOSupplier<? extends T> before) {
* @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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
* @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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
* @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
*/
Expand Down
Loading

0 comments on commit b27a9d0

Please sign in to comment.