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
commit c5e8b7b4f8fbd03e3e96098030409fc9edb56bde
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Thu Jul 28 00:23:19 2022 -0400
Javadoc
---
.../apache/commons/io/function/IOBiConsumer.java | 2 +-
.../apache/commons/io/function/IOBiFunction.java | 2 +-
.../org/apache/commons/io/function/IOConsumer.java | 3 +-
.../org/apache/commons/io/function/IOFunction.java | 95 +++++++++-------------
.../apache/commons/io/function/IOPredicate.java | 2 +-
.../org/apache/commons/io/function/IOSupplier.java | 2 +-
6 files changed, 42 insertions(+), 64 deletions(-)
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 fbe25077..652b573a 100644
--- a/src/main/java/org/apache/commons/io/function/IOBiConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOBiConsumer.java
@@ -73,7 +73,7 @@ public interface IOBiConsumer<T, U> {
}
/**
- * 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.
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 0d7ca5af..9a96909c 100644
--- a/src/main/java/org/apache/commons/io/function/IOBiFunction.java
+++ b/src/main/java/org/apache/commons/io/function/IOBiFunction.java
@@ -79,7 +79,7 @@ public interface IOBiFunction<T, U, R> {
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.
diff --git a/src/main/java/org/apache/commons/io/function/IOConsumer.java
b/src/main/java/org/apache/commons/io/function/IOConsumer.java
index a7aef3da..54db62b2 100644
--- a/src/main/java/org/apache/commons/io/function/IOConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOConsumer.java
@@ -156,8 +156,7 @@ public interface IOConsumer<T> {
}
/**
- * 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
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 c1c08026..ed9b2395 100644
--- a/src/main/java/org/apache/commons/io/function/IOFunction.java
+++ b/src/main/java/org/apache/commons/io/function/IOFunction.java
@@ -45,14 +45,12 @@ public interface IOFunction<T, R> {
}
/**
- * 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 @@ public interface IOFunction<T, R> {
}
/**
- * 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 @@ public interface IOFunction<T, R> {
}
/**
- * 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 @@ public interface IOFunction<T, R> {
}
/**
- * 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 @@ public interface IOFunction<T, R> {
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 @@ public interface IOFunction<T, R> {
}
/**
- * 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 @@ public interface IOFunction<T, R> {
}
/**
- * 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 @@ public interface IOFunction<T, R> {
}
/**
- * 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 @@ public interface IOFunction<T, R> {
}
/**
- * 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)
diff --git a/src/main/java/org/apache/commons/io/function/IOPredicate.java
b/src/main/java/org/apache/commons/io/function/IOPredicate.java
index c7b4fe6a..fb9062b3 100644
--- a/src/main/java/org/apache/commons/io/function/IOPredicate.java
+++ b/src/main/java/org/apache/commons/io/function/IOPredicate.java
@@ -85,7 +85,7 @@ public interface IOPredicate<T> {
}
/**
- * 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.
diff --git a/src/main/java/org/apache/commons/io/function/IOSupplier.java
b/src/main/java/org/apache/commons/io/function/IOSupplier.java
index a9a656a2..cbdfac83 100644
--- a/src/main/java/org/apache/commons/io/function/IOSupplier.java
+++ b/src/main/java/org/apache/commons/io/function/IOSupplier.java
@@ -31,7 +31,7 @@ import java.util.function.Supplier;
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
