Javadoc

Author: Gary Gregory

src/main/java/org/apache/commons/io/function/IOBiConsumer.java

@@ -73,7 +73,7 @@ default IOBiConsumer<T, U> andThen(final IOBiConsumer<? super T, ? super U> afte
     }
 
     /**
-     * Converts this instance to a {@link BiConsumer} that throws {@link UncheckedIOException} instead of
+     * Creates a {@link BiConsumer} for this instance that throws {@link UncheckedIOException} instead of
      * {@link IOException}.
      *
      * @return an unchecked BiConsumer.

src/main/java/org/apache/commons/io/function/IOBiFunction.java

@@ -79,7 +79,7 @@ default <V> IOBiFunction<T, U, V> andThen(final IOFunction<? super R, ? extends
     R apply(T t, U u) throws IOException;
 
     /**
-     * Converts this instance to a {@link BiFunction} that throws {@link UncheckedIOException} instead of
+     * Creates a {@link BiFunction} for this instance that throws {@link UncheckedIOException} instead of
      * {@link IOException}.
      *
      * @return an unchecked BiFunction.

src/main/java/org/apache/commons/io/function/IOConsumer.java

@@ -156,8 +156,7 @@ default IOConsumer<T> andThen(final IOConsumer<? super T> after) {
     }
 
     /**
-     * Converts this instance to a {@link Consumer} that throws {@link UncheckedIOException} instead of
-     * {@link IOException}.
+     * Creates a {@link Consumer} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
      *
      * @return an unchecked Consumer.
      * @since 2.12.0

src/main/java/org/apache/commons/io/function/IOFunction.java

@@ -45,14 +45,12 @@ static <T> IOFunction<T, T> identity() {
     }
 
     /**
-     * Returns a composed {@link IOFunction} that first applies this function to
-     * its input, and then applies the {@code after} consumer to the result.
-     * If evaluation of either function throws an exception, it is relayed to
-     * the caller of the composed function.
+     * Returns a composed {@link IOFunction} that first applies this function to its input, and then applies the
+     * {@code after} consumer to the result. If evaluation of either function throws an exception, it is relayed to the
+     * caller of the composed function.
      *
      * @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
+     * @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)
@@ -63,16 +61,13 @@ default IOConsumer<T> andThen(final Consumer<? super R> after) {
     }
 
     /**
-     * Returns a composed {@link IOFunction} that first applies this function to
-     * its input, and then applies the {@code after} function to the result.
-     * If evaluation of either function throws an exception, it is relayed to
-     * the caller of the composed function.
+     * Returns a composed {@link IOFunction} that first applies this function to its input, and then applies the
+     * {@code after} function to the result. If evaluation of either function throws an exception, it is relayed to the
+     * caller of the composed function.
      *
-     * @param <V> the type of output of the {@code after} function, and of the
-     *           composed function
+     * @param <V> the type of output of the {@code after} function, and of the composed function
      * @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
+     * @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)
@@ -83,14 +78,12 @@ default <V> IOFunction<T, V> andThen(final Function<? super R, ? extends V> afte
     }
 
     /**
-     * Returns a composed {@link IOFunction} that first applies this function to
-     * its input, and then applies the {@code after} consumer to the result.
-     * If evaluation of either function throws an exception, it is relayed to
-     * the caller of the composed function.
+     * Returns a composed {@link IOFunction} that first applies this function to its input, and then applies the
+     * {@code after} consumer to the result. If evaluation of either function throws an exception, it is relayed to the
+     * caller of the composed function.
      *
      * @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
+     * @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)
@@ -101,16 +94,13 @@ default IOConsumer<T> andThen(final IOConsumer<? super R> after) {
     }
 
     /**
-     * Returns a composed {@link IOFunction} that first applies this function to
-     * its input, and then applies the {@code after} function to the result.
-     * If evaluation of either function throws an exception, it is relayed to
-     * the caller of the composed function.
+     * Returns a composed {@link IOFunction} that first applies this function to its input, and then applies the
+     * {@code after} function to the result. If evaluation of either function throws an exception, it is relayed to the
+     * caller of the composed function.
      *
-     * @param <V> the type of output of the {@code after} function, and of the
-     *           composed function
+     * @param <V> the type of output of the {@code after} function, and of the composed function
      * @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
+     * @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)
@@ -130,8 +120,7 @@ default <V> IOFunction<T, V> andThen(final IOFunction<? super R, ? extends V> af
     R apply(final T t) throws IOException;
 
     /**
-     * Converts this instance to a {@link Function} that throws {@link UncheckedIOException} instead of
-     * {@link IOException}.
+     * Creates a {@link Function} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
      *
      * @return an unchecked Function.
      * @since 2.12.0
@@ -141,16 +130,13 @@ default Function<T, R> asFunction() {
     }
 
     /**
-     * Returns a composed {@link IOFunction} that first applies the {@code before}
-     * function to its input, and then applies this function to the result.
-     * If evaluation of either function throws an exception, it is relayed to
-     * the caller of the composed function.
+     * Returns a composed {@link IOFunction} that first applies the {@code before} function to its input, and then applies
+     * this function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the
+     * composed function.
      *
-     * @param <V> the type of input to the {@code before} function, and to the
-     *           composed function
+     * @param <V> the type of input to the {@code before} function, and to the composed function
      * @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
+     * @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)
@@ -161,16 +147,13 @@ default <V> IOFunction<V, R> compose(final Function<? super V, ? extends T> befo
     }
 
     /**
-     * Returns a composed {@link IOFunction} that first applies the {@code before}
-     * function to its input, and then applies this function to the result.
-     * If evaluation of either function throws an exception, it is relayed to
-     * the caller of the composed function.
+     * Returns a composed {@link IOFunction} that first applies the {@code before} function to its input, and then applies
+     * this function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the
+     * composed function.
      *
-     * @param <V> the type of input to the {@code before} function, and to the
-     *           composed function
+     * @param <V> the type of input to the {@code before} function, and to the composed function
      * @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
+     * @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)
@@ -181,14 +164,12 @@ default <V> IOFunction<V, R> compose(final IOFunction<? super V, ? extends T> be
     }
 
     /**
-     * Returns a composed {@link IOFunction} that first applies the {@code before}
-     * function to its input, and then applies this function to the result.
-     * If evaluation of either function throws an exception, it is relayed to
-     * the caller of the composed function.
+     * Returns a composed {@link IOFunction} that first applies the {@code before} function to its input, and then applies
+     * this function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the
+     * composed function.
      *
      * @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
+     * @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)
@@ -199,14 +180,12 @@ default IOSupplier<R> compose(final IOSupplier<? extends T> before) {
     }
 
     /**
-     * Returns a composed {@link IOFunction} that first applies the {@code before}
-     * function to its input, and then applies this function to the result.
-     * If evaluation of either function throws an exception, it is relayed to
-     * the caller of the composed function.
+     * Returns a composed {@link IOFunction} that first applies the {@code before} function to its input, and then applies
+     * this function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the
+     * composed function.
      *
      * @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
+     * @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)

src/main/java/org/apache/commons/io/function/IOPredicate.java

@@ -85,7 +85,7 @@ default IOPredicate<T> and(final IOPredicate<? super T> other) {
     }
 
     /**
-     * Converts this instance to a {@link Predicate} that throws {@link UncheckedIOException} instead of
+     * Creates a {@link Predicate} for this instance that throws {@link UncheckedIOException} instead of
      * {@link IOException}.
      *
      * @return an unchecked Predicate.

src/main/java/org/apache/commons/io/function/IOSupplier.java

@@ -31,7 +31,7 @@
 public interface IOSupplier<T> {
 
     /**
-     * Converts this instance to a Supplier that throws {@link UncheckedIOException} instead of {@link IOException}.
+     * Creates a {@link Supplier} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
      *
      * @return an unchecked Predicate.
      * @since 2.12.0