diff options
author | Gary Gregory <garydgregory@gmail.com> | 2022-05-28 07:53:27 -0400 |
---|---|---|
committer | Gary Gregory <garydgregory@gmail.com> | 2022-05-28 07:53:27 -0400 |
commit | 247cae4896c282f50570374dc41b62269223ee36 (patch) | |
tree | afe2ac6d14088c95ae50e9da2b4dc17a9c572b68 /src/main/java/org/apache/commons/lang3/function | |
parent | 6eb223bb8c68540e3f2bfa08c3d87b4cf7dfb544 (diff) | |
download | apache-commons-lang-247cae4896c282f50570374dc41b62269223ee36.tar.gz |
Better Javadoc
Diffstat (limited to 'src/main/java/org/apache/commons/lang3/function')
44 files changed, 86 insertions, 86 deletions
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableBiConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableBiConsumer.java index 24cccd14f..54da7b3ba 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableBiConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableBiConsumer.java @@ -25,7 +25,7 @@ import java.util.function.BiConsumer; * * @param <T> Consumed type 1. * @param <U> Consumed type 2. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -40,7 +40,7 @@ public interface FailableBiConsumer<T, U, E extends Throwable> { * * @param <T> Consumed type 1. * @param <U> Consumed type 2. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java index f38d3a965..caa964bc1 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java @@ -27,7 +27,7 @@ import java.util.function.Function; * @param <T> Input type 1. * @param <U> Input type 2. * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -43,7 +43,7 @@ public interface FailableBiFunction<T, U, R, E extends Throwable> { * @param <T> Consumed type 1. * @param <U> Consumed type 2. * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java b/src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java index b675cabfc..d8ad16b08 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java @@ -25,7 +25,7 @@ import java.util.function.BiPredicate; * * @param <T> Predicate type 1. * @param <U> Predicate type 2. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -44,7 +44,7 @@ public interface FailableBiPredicate<T, U, E extends Throwable> { * * @param <T> Consumed type 1. * @param <U> Consumed type 2. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") @@ -57,7 +57,7 @@ public interface FailableBiPredicate<T, U, E extends Throwable> { * * @param <T> Consumed type 1. * @param <U> Consumed type 2. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableBooleanSupplier.java b/src/main/java/org/apache/commons/lang3/function/FailableBooleanSupplier.java index 89facde0e..a6c1d09d4 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableBooleanSupplier.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableBooleanSupplier.java @@ -22,7 +22,7 @@ import java.util.function.BooleanSupplier; /** * A functional interface like {@link BooleanSupplier} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableCallable.java b/src/main/java/org/apache/commons/lang3/function/FailableCallable.java index 7e3a4d40c..3b5c6ca0f 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableCallable.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableCallable.java @@ -21,7 +21,7 @@ package org.apache.commons.lang3.function; * A functional interface like {@link java.util.concurrent.Callable} that declares a {@code Throwable}. * * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java index d0535e13c..c70d4bffb 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java @@ -43,7 +43,7 @@ public interface FailableConsumer<T, E extends Throwable> { * Returns The NOP singleton. * * @param <T> Consumed type 1. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleBinaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleBinaryOperator.java index aefc8b791..23b1f51bf 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleBinaryOperator.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleBinaryOperator.java @@ -22,7 +22,7 @@ import java.util.function.DoubleBinaryOperator; /** * A functional interface like {@link DoubleBinaryOperator} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleConsumer.java index b926f8ca4..d722289ba 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleConsumer.java @@ -23,7 +23,7 @@ import java.util.function.DoubleConsumer; /** * A functional interface like {@link DoubleConsumer} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -36,7 +36,7 @@ public interface FailableDoubleConsumer<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java index f4a12b6c5..098621b9c 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java @@ -23,7 +23,7 @@ import java.util.function.DoubleFunction; * A functional interface like {@link DoubleFunction} that declares a {@code Throwable}. * * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableDoubleFunction<R, E extends Throwable> { * Returns The NOP singleton. * * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoublePredicate.java b/src/main/java/org/apache/commons/lang3/function/FailableDoublePredicate.java index a25333320..50c09d76b 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableDoublePredicate.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableDoublePredicate.java @@ -23,7 +23,7 @@ import java.util.function.DoublePredicate; /** * A functional interface like {@link DoublePredicate} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -40,7 +40,7 @@ public interface FailableDoublePredicate<E extends Throwable> { /** * Returns The FALSE singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") @@ -51,7 +51,7 @@ public interface FailableDoublePredicate<E extends Throwable> { /** * Returns The TRUE singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleSupplier.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleSupplier.java index 0024ef2c7..07539f0cf 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleSupplier.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleSupplier.java @@ -22,7 +22,7 @@ import java.util.function.DoubleSupplier; /** * A functional interface like {@link DoubleSupplier} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java index ac4af8b60..8e037c2de 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java @@ -22,7 +22,7 @@ import java.util.function.DoubleToIntFunction; /** * A functional interface like {@link DoubleToIntFunction} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -35,7 +35,7 @@ public interface FailableDoubleToIntFunction<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java index ed146aabb..ec386d187 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java @@ -22,7 +22,7 @@ import java.util.function.DoubleToLongFunction; /** * A functional interface like {@link DoubleToLongFunction} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -35,7 +35,7 @@ public interface FailableDoubleToLongFunction<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java index 7a677f953..a3db79214 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java @@ -23,7 +23,7 @@ import java.util.function.DoubleUnaryOperator; /** * A functional interface like {@link DoubleUnaryOperator} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ public interface FailableDoubleUnaryOperator<E extends Throwable> { @@ -35,7 +35,7 @@ public interface FailableDoubleUnaryOperator<E extends Throwable> { /** * Returns a unary operator that always returns its input argument. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return a unary operator that always returns its input argument */ static <E extends Throwable> FailableDoubleUnaryOperator<E> identity() { @@ -45,7 +45,7 @@ public interface FailableDoubleUnaryOperator<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableFunction.java index 3257f69b5..4da137716 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableFunction.java @@ -25,7 +25,7 @@ import java.util.function.Function; * * @param <T> Input type 1. * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -39,7 +39,7 @@ public interface FailableFunction<T, R, E extends Throwable> { * Returns a function that always returns its input argument. * * @param <T> the type of the input and output objects to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return a function that always returns its input argument */ static <T, E extends Throwable> FailableFunction<T, T, E> identity() { @@ -51,7 +51,7 @@ public interface FailableFunction<T, R, E extends Throwable> { * * @param <T> Consumed type 1. * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntBinaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableIntBinaryOperator.java index bc2263024..65753d9a8 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableIntBinaryOperator.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableIntBinaryOperator.java @@ -22,7 +22,7 @@ import java.util.function.IntBinaryOperator; /** * A functional interface like {@link IntBinaryOperator} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableIntConsumer.java index 5c68a4344..0b21aa019 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableIntConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableIntConsumer.java @@ -23,7 +23,7 @@ import java.util.function.IntConsumer; /** * A functional interface like {@link IntConsumer} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -36,7 +36,7 @@ public interface FailableIntConsumer<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java index 9ca07bb99..355f168d0 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java @@ -23,7 +23,7 @@ import java.util.function.IntFunction; * A functional interface like {@link IntFunction} that declares a {@code Throwable}. * * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableIntFunction<R, E extends Throwable> { * Returns The NOP singleton. * * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntPredicate.java b/src/main/java/org/apache/commons/lang3/function/FailableIntPredicate.java index 626aee16f..66922982a 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableIntPredicate.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableIntPredicate.java @@ -23,7 +23,7 @@ import java.util.function.IntPredicate; /** * A functional interface like {@link IntPredicate} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -40,7 +40,7 @@ public interface FailableIntPredicate<E extends Throwable> { /** * Returns The FALSE singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") @@ -51,7 +51,7 @@ public interface FailableIntPredicate<E extends Throwable> { /** * Returns The TRUE singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntSupplier.java b/src/main/java/org/apache/commons/lang3/function/FailableIntSupplier.java index d1478aa4e..ac60e0f1b 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableIntSupplier.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableIntSupplier.java @@ -22,7 +22,7 @@ import java.util.function.IntSupplier; /** * A functional interface like {@link IntSupplier} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java index 4e8280cc1..b9a41cb40 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java @@ -22,7 +22,7 @@ import java.util.function.IntToDoubleFunction; /** * A functional interface like {@link IntToDoubleFunction} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -35,7 +35,7 @@ public interface FailableIntToDoubleFunction<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java index ec58aaafe..422521d3a 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java @@ -22,7 +22,7 @@ import java.util.function.IntToLongFunction; /** * A functional interface like {@link IntToLongFunction} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -35,7 +35,7 @@ public interface FailableIntToLongFunction<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java index c769ceefa..8772a0c4f 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java @@ -23,7 +23,7 @@ import java.util.function.IntUnaryOperator; /** * A functional interface like {@link IntUnaryOperator} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ public interface FailableIntUnaryOperator<E extends Throwable> { @@ -35,7 +35,7 @@ public interface FailableIntUnaryOperator<E extends Throwable> { /** * Returns a unary operator that always returns its input argument. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return a unary operator that always returns its input argument */ static <E extends Throwable> FailableIntUnaryOperator<E> identity() { @@ -45,7 +45,7 @@ public interface FailableIntUnaryOperator<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongBinaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableLongBinaryOperator.java index a7a3e080a..4d594ff0b 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableLongBinaryOperator.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableLongBinaryOperator.java @@ -22,7 +22,7 @@ import java.util.function.LongBinaryOperator; /** * A functional interface like {@link LongBinaryOperator} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableLongConsumer.java index 33ab3bf33..395bbc03b 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableLongConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableLongConsumer.java @@ -23,7 +23,7 @@ import java.util.function.LongConsumer; /** * A functional interface like {@link LongConsumer} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -36,7 +36,7 @@ public interface FailableLongConsumer<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java index 3f0921f6c..5aa27a131 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java @@ -23,7 +23,7 @@ import java.util.function.LongFunction; * A functional interface like {@link LongFunction} that declares a {@code Throwable}. * * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableLongFunction<R, E extends Throwable> { * Returns The NOP singleton. * * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java b/src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java index 414d8754b..c239a2fac 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java @@ -23,7 +23,7 @@ import java.util.function.LongPredicate; /** * A functional interface like {@link LongPredicate} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -40,7 +40,7 @@ public interface FailableLongPredicate<E extends Throwable> { /** * Returns The FALSE singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") @@ -51,7 +51,7 @@ public interface FailableLongPredicate<E extends Throwable> { /** * Returns The TRUE singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongSupplier.java b/src/main/java/org/apache/commons/lang3/function/FailableLongSupplier.java index 07d246dbb..ddf90128a 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableLongSupplier.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableLongSupplier.java @@ -22,7 +22,7 @@ import java.util.function.LongSupplier; /** * A functional interface like {@link LongSupplier} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java index 0fe9a1540..c7c5c2f15 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java @@ -22,7 +22,7 @@ import java.util.function.LongToDoubleFunction; /** * A functional interface like {@link LongToDoubleFunction} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -35,7 +35,7 @@ public interface FailableLongToDoubleFunction<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java index 8af433db9..419fd657a 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java @@ -22,7 +22,7 @@ import java.util.function.LongToIntFunction; /** * A functional interface like {@link LongToIntFunction} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -35,7 +35,7 @@ public interface FailableLongToIntFunction<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java index b94150af1..4b7d6e080 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java @@ -23,7 +23,7 @@ import java.util.function.LongUnaryOperator; /** * A functional interface like {@link LongUnaryOperator} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ public interface FailableLongUnaryOperator<E extends Throwable> { @@ -35,7 +35,7 @@ public interface FailableLongUnaryOperator<E extends Throwable> { /** * Returns a unary operator that always returns its input argument. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return a unary operator that always returns its input argument */ static <E extends Throwable> FailableLongUnaryOperator<E> identity() { @@ -45,7 +45,7 @@ public interface FailableLongUnaryOperator<E extends Throwable> { /** * Returns The NOP singleton. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableObjDoubleConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableObjDoubleConsumer.java index 3b74e176c..4fe4ea974 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableObjDoubleConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableObjDoubleConsumer.java @@ -23,7 +23,7 @@ import java.util.function.ObjDoubleConsumer; * A functional interface like {@link ObjDoubleConsumer} that declares a {@code Throwable}. * * @param <T> the type of the object argument to the operation. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableObjDoubleConsumer<T, E extends Throwable> { * Returns The NOP singleton. * * @param <T> the type of the object argument to the operation. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableObjIntConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableObjIntConsumer.java index 17a6ac12d..62ee8e579 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableObjIntConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableObjIntConsumer.java @@ -23,7 +23,7 @@ import java.util.function.ObjIntConsumer; * A functional interface like {@link ObjIntConsumer} that declares a {@code Throwable}. * * @param <T> the type of the object argument to the operation. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableObjIntConsumer<T, E extends Throwable> { * Returns The NOP singleton. * * @param <T> the type of the object argument to the operation. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableObjLongConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableObjLongConsumer.java index ac2a9ec02..bc1ff2ebc 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableObjLongConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableObjLongConsumer.java @@ -23,7 +23,7 @@ import java.util.function.ObjLongConsumer; * A functional interface like {@link ObjLongConsumer} that declares a {@code Throwable}. * * @param <T> the type of the object argument to the operation. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableObjLongConsumer<T, E extends Throwable> { * Returns The NOP singleton. * * @param <T> the type of the object argument to the operation. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailablePredicate.java b/src/main/java/org/apache/commons/lang3/function/FailablePredicate.java index 200117ed3..7ba62a451 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailablePredicate.java +++ b/src/main/java/org/apache/commons/lang3/function/FailablePredicate.java @@ -24,7 +24,7 @@ import java.util.function.Predicate; * A functional interface like {@link Predicate} that declares a {@code Throwable}. * * @param <T> Predicate type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -42,7 +42,7 @@ public interface FailablePredicate<T, E extends Throwable> { * Returns The FALSE singleton. * * @param <T> Predicate type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") @@ -54,7 +54,7 @@ public interface FailablePredicate<T, E extends Throwable> { * Returns The TRUE singleton. * * @param <T> Predicate type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableRunnable.java b/src/main/java/org/apache/commons/lang3/function/FailableRunnable.java index 06bd72f5e..46103c9e8 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableRunnable.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableRunnable.java @@ -18,9 +18,9 @@ package org.apache.commons.lang3.function; /** - * A functional interface like {@link Runnable} that declares a {@code Throwable}. + * A functional interface like {@link Runnable} that declares a kind of {@link Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of {@link Throwable}. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableShortSupplier.java b/src/main/java/org/apache/commons/lang3/function/FailableShortSupplier.java index d6731e30a..cf3b72da6 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableShortSupplier.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableShortSupplier.java @@ -22,7 +22,7 @@ import java.util.function.IntSupplier; /** * A functional interface like {@link IntSupplier} but for {@code short} that declares a {@code Throwable}. * - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.12.0 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableSupplier.java b/src/main/java/org/apache/commons/lang3/function/FailableSupplier.java index 1a1095695..521180afb 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableSupplier.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableSupplier.java @@ -23,7 +23,7 @@ import java.util.function.Supplier; * A functional interface like {@link Supplier} that declares a {@code Throwable}. * * @param <R> Return type. - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java index 009e38a81..97a321d3d 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java @@ -24,7 +24,7 @@ import java.util.function.ToDoubleBiFunction; * * @param <T> the type of the first argument to the function * @param <U> the type of the second argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -39,7 +39,7 @@ public interface FailableToDoubleBiFunction<T, U, E extends Throwable> { * * @param <T> the type of the first argument to the function * @param <U> the type of the second argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java index 0c51cb34e..211aa66ae 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java @@ -23,7 +23,7 @@ import java.util.function.ToDoubleFunction; * A functional interface like {@link ToDoubleFunction} that declares a {@code Throwable}. * * @param <T> the type of the argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableToDoubleFunction<T, E extends Throwable> { * Returns The NOP singleton. * * @param <T> the type of the argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java index 0de3cb87e..a76238921 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java @@ -24,7 +24,7 @@ import java.util.function.ToIntBiFunction; * * @param <T> the type of the first argument to the function * @param <U> the type of the second argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -39,7 +39,7 @@ public interface FailableToIntBiFunction<T, U, E extends Throwable> { * * @param <T> the type of the first argument to the function * @param <U> the type of the second argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java index bc05fbf88..8dc2f4d7c 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java @@ -23,7 +23,7 @@ import java.util.function.ToIntFunction; * A functional interface like {@link ToIntFunction} that declares a {@code Throwable}. * * @param <T> the type of the argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableToIntFunction<T, E extends Throwable> { * Returns The NOP singleton. * * @param <T> the type of the argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java index 0ad0d88e4..87312d6f2 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java @@ -24,7 +24,7 @@ import java.util.function.ToLongBiFunction; * * @param <T> the type of the first argument to the function * @param <U> the type of the second argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -39,7 +39,7 @@ public interface FailableToLongBiFunction<T, U, E extends Throwable> { * * @param <T> the type of the first argument to the function * @param <U> the type of the second argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java index 6053d074e..99bb53bc6 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java @@ -23,7 +23,7 @@ import java.util.function.ToLongFunction; * A functional interface like {@link ToLongFunction} that declares a {@code Throwable}. * * @param <T> the type of the first argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @since 3.11 */ @FunctionalInterface @@ -37,7 +37,7 @@ public interface FailableToLongFunction<T, E extends Throwable> { * Returns The NOP singleton. * * @param <T> the type of the argument to the function - * @param <E> Thrown exception. + * @param <E> The kind of thrown exception or error. * @return The NOP singleton. */ @SuppressWarnings("unchecked") |