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 16acf1695f1258dd069dc63bafd35743179010b3
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Thu Jul 28 10:03:36 2022 -0400
Javadoc
---
src/main/java/org/apache/commons/io/function/IOBiConsumer.java | 7 ++++---
src/main/java/org/apache/commons/io/function/IOBiFunction.java | 6 +++---
src/main/java/org/apache/commons/io/function/IOConsumer.java | 6 +++---
src/main/java/org/apache/commons/io/function/IOFunction.java | 2 +-
src/main/java/org/apache/commons/io/function/IOPredicate.java | 10 +++++-----
.../java/org/apache/commons/io/function/IOQuadFunction.java | 2 +-
src/main/java/org/apache/commons/io/function/IORunnable.java | 2 +-
src/main/java/org/apache/commons/io/function/IOSupplier.java | 2 +-
.../java/org/apache/commons/io/function/IOTriConsumer.java | 4 ++--
.../java/org/apache/commons/io/function/IOTriFunction.java | 2 +-
10 files changed, 22 insertions(+), 21 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 652b573a..492ff4e5 100644
--- a/src/main/java/org/apache/commons/io/function/IOBiConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOBiConsumer.java
@@ -35,7 +35,7 @@ import java.util.function.BiConsumer;
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 @@ public interface IOBiConsumer<T, U> {
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 @@ public interface IOBiConsumer<T, U> {
* 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() {
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 9a96909c..23e9b8b8 100644
--- a/src/main/java/org/apache/commons/io/function/IOBiFunction.java
+++ b/src/main/java/org/apache/commons/io/function/IOBiFunction.java
@@ -42,7 +42,7 @@ import java.util.function.Function;
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 @@ public interface IOBiFunction<T, U, 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.
*
@@ -82,7 +82,7 @@ public interface IOBiFunction<T, U, R> {
* 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);
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 54db62b2..5b912464 100644
--- a/src/main/java/org/apache/commons/io/function/IOConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOConsumer.java
@@ -36,7 +36,7 @@ import org.apache.commons.io.IOIndexedException;
public interface IOConsumer<T> {
/**
- * Package private constant; consider private.
+ * Consider private.
*/
IOConsumer<?> NOOP_IO_CONSUMER = t -> {/* noop */};
@@ -119,7 +119,7 @@ public interface IOConsumer<T> {
}
/**
- * 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 @@ public interface IOConsumer<T> {
/**
* 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() {
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 ed9b2395..7fffacd8 100644
--- a/src/main/java/org/apache/commons/io/function/IOFunction.java
+++ b/src/main/java/org/apache/commons/io/function/IOFunction.java
@@ -122,7 +122,7 @@ public interface IOFunction<T, R> {
/**
* 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() {
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 fb9062b3..c2170afd 100644
--- a/src/main/java/org/apache/commons/io/function/IOPredicate.java
+++ b/src/main/java/org/apache/commons/io/function/IOPredicate.java
@@ -54,7 +54,7 @@ public interface IOPredicate<T> {
}
/**
- * 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 @@ public interface IOPredicate<T> {
}
/**
- * 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 @@ public interface IOPredicate<T> {
* 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 @@ public interface IOPredicate<T> {
}
/**
- * 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.
*
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 470d4950..161fe6e6 100644
--- a/src/main/java/org/apache/commons/io/function/IOQuadFunction.java
+++ b/src/main/java/org/apache/commons/io/function/IOQuadFunction.java
@@ -42,7 +42,7 @@ import java.util.function.Function;
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.
*
diff --git a/src/main/java/org/apache/commons/io/function/IORunnable.java
b/src/main/java/org/apache/commons/io/function/IORunnable.java
index 8afa2979..60b76bd7 100644
--- a/src/main/java/org/apache/commons/io/function/IORunnable.java
+++ b/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);
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 cbdfac83..5a81b407 100644
--- a/src/main/java/org/apache/commons/io/function/IOSupplier.java
+++ b/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() {
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 1d2db208..27a629fb 100644
--- a/src/main/java/org/apache/commons/io/function/IOTriConsumer.java
+++ b/src/main/java/org/apache/commons/io/function/IOTriConsumer.java
@@ -35,7 +35,7 @@ import java.util.function.BiConsumer;
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 @@ public interface IOTriConsumer<T, U, V> {
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.
*
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 d89ee1e8..ddd3b210 100644
--- a/src/main/java/org/apache/commons/io/function/IOTriFunction.java
+++ b/src/main/java/org/apache/commons/io/function/IOTriFunction.java
@@ -41,7 +41,7 @@ import java.util.function.Function;
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.
*
