Javadoc

Author: Gary Gregory

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

@@ -35,7 +35,7 @@
 public interface IOBiConsumer<T, U> {
 
     /**
-     * Returns The no-op singleton.
+     * Returns the no-op singleton.
      *
      * @param <T> the type of the first argument to the operation
      * @param <U> the type of the second argument to the operation
@@ -55,7 +55,7 @@ static <T, U> IOBiConsumer<T, U> noop() {
     void accept(T t, U u) throws IOException;
 
     /**
-     * Returns a composed {@link IOBiConsumer} that performs, in sequence, this operation followed by the {@code after}
+     * Creates a composed {@link IOBiConsumer} that performs, in sequence, this operation followed by the {@code after}
      * operation. If performing either operation throws an exception, it is relayed to the caller of the composed operation.
      * If performing this operation throws an exception, the {@code after} operation will not be performed.
      *
@@ -76,7 +76,8 @@ default IOBiConsumer<T, U> andThen(final IOBiConsumer<? super T, ? super U> afte
      * Creates a {@link BiConsumer} for this instance that throws {@link UncheckedIOException} instead of
      * {@link IOException}.
      *
-     * @return an unchecked BiConsumer.
+     * @return an UncheckedIOException BiConsumer.
+     * @throws UncheckedIOException Wraps an {@link IOException}.
      * @since 2.12.0
      */
     default BiConsumer<T, U> asBiConsumer() {

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

@@ -42,7 +42,7 @@
 public interface IOBiFunction<T, U, R> {
 
     /**
-     * Returns The p singleton.
+     * Returns the no-op singleton.
      *
      * @param <T> the type of the first argument to the function
      * @param <U> the type of the second argument to the function
@@ -54,7 +54,7 @@ static <T, U, R> IOBiFunction<T, U, R> noop() {
     }
 
     /**
-     * Returns a composed function that first applies this function to its input, and then applies the {@code after}
+     * Creates a composed function 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.
      *
@@ -82,7 +82,7 @@ default <V> IOBiFunction<T, U, V> andThen(final IOFunction<? super R, ? extends
      * Creates a {@link BiFunction} for this instance that throws {@link UncheckedIOException} instead of
      * {@link IOException}.
      *
-     * @return an unchecked BiFunction.
+     * @return an UncheckedIOException BiFunction.
      */
     default BiFunction<T, U, R> asBiFunction() {
         return (t, u) -> Uncheck.apply(this, t, u);

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

@@ -36,7 +36,7 @@
 public interface IOConsumer<T> {
 
     /**
-     * Package private constant; consider private.
+     * Consider private.
      */
     IOConsumer<?> NOOP_IO_CONSUMER = t -> {/* noop */};
 
@@ -119,7 +119,7 @@ static <T> void forEach(final T[] array, final IOConsumer<T> action) throws IOEx
     }
 
     /**
-     * Returns a constant no-op consumer.
+     * Returns the constant no-op consumer.
      *
      * @param <T> Type consumer type.
      * @return a constant no-op consumer.
@@ -158,7 +158,7 @@ default IOConsumer<T> andThen(final IOConsumer<? super T> after) {
     /**
      * Creates a {@link Consumer} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
      *
-     * @return an unchecked Consumer.
+     * @return an UncheckedIOException Consumer.
      * @since 2.12.0
      */
     default Consumer<T> asConsumer() {

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

@@ -122,7 +122,7 @@ default <V> IOFunction<T, V> andThen(final IOFunction<? super R, ? extends V> af
     /**
      * Creates a {@link Function} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
      *
-     * @return an unchecked Function.
+     * @return an UncheckedIOException Function.
      * @since 2.12.0
      */
     default Function<T, R> asFunction() {

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

@@ -54,7 +54,7 @@ static <T> IOPredicate<T> alwaysTrue() {
     }
 
     /**
-     * Returns a predicate that tests if two arguments are equal using {@link Objects#equals(Object, Object)}.
+     * Creates a predicate that tests if two arguments are equal using {@link Objects#equals(Object, Object)}.
      *
      * @param <T> the type of arguments to the predicate
      * @param target the object to compare for equality, may be {@code null}
@@ -65,7 +65,7 @@ static <T> IOPredicate<T> isEqual(final Object target) {
     }
 
     /**
-     * Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another. When
+     * Creates a composed predicate that represents a short-circuiting logical AND of this predicate and another. When
      * evaluating the composed predicate, if this predicate is {@code false}, then the {@code other} predicate is not
      * evaluated.
      *
@@ -88,14 +88,14 @@ default IOPredicate<T> and(final IOPredicate<? super T> other) {
      * Creates a {@link Predicate} for this instance that throws {@link UncheckedIOException} instead of
      * {@link IOException}.
      *
-     * @return an unchecked Predicate.
+     * @return an UncheckedIOException Predicate.
      */
     default Predicate<T> asPredicate() {
         return t -> Uncheck.test(this, t);
     }
 
     /**
-     * Returns a predicate that represents the logical negation of this predicate.
+     * Creates a predicate that represents the logical negation of this predicate.
      *
      * @return a predicate that represents the logical negation of this predicate
      */
@@ -104,7 +104,7 @@ default IOPredicate<T> negate() {
     }
 
     /**
-     * Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another. When
+     * Creates a composed predicate that represents a short-circuiting logical OR of this predicate and another. When
      * evaluating the composed predicate, if this predicate is {@code true}, then the {@code other} predicate is not
      * evaluated.
      *

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

@@ -42,7 +42,7 @@
 public interface IOQuadFunction<T, U, V, W, R> {
 
     /**
-     * Returns a composed function that first applies this function to its input, and then applies the {@code after}
+     * Creates a composed function 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.
      *

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

@@ -31,7 +31,7 @@ public interface IORunnable {
     /**
      * Creates a {@link Runnable} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
      *
-     * @return an unchecked Predicate.
+     * @return an UncheckedIOException Predicate.
      */
     default Runnable asRunnable() {
         return () -> Uncheck.run(this);

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

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

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

@@ -35,7 +35,7 @@
 public interface IOTriConsumer<T, U, V> {
 
     /**
-     * Returns The no-op singleton.
+     * Returns the no-op singleton.
      *
      * @param <T> the type of the first argument to the operation
      * @param <U> the type of the second argument to the operation
@@ -57,7 +57,7 @@ static <T, U, V> IOTriConsumer<T, U, V> noop() {
     void accept(T t, U u, V v) throws IOException;
 
     /**
-     * Returns a composed {@link IOTriConsumer} that performs, in sequence, this operation followed by the {@code after}
+     * Creates a composed {@link IOTriConsumer} that performs, in sequence, this operation followed by the {@code after}
      * operation. If performing either operation throws an exception, it is relayed to the caller of the composed operation.
      * If performing this operation throws an exception, the {@code after} operation will not be performed.
      *

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

@@ -41,7 +41,7 @@
 public interface IOTriFunction<T, U, V, R> {
 
     /**
-     * Returns a composed function that first applies this function to its input, and then applies the {@code after}
+     * Creates a composed function 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.
      *