Javadoc

Author: garydgregory

src/main/java/org/apache/commons/lang3/function/BooleanConsumer.java

@@ -33,7 +33,7 @@ public interface BooleanConsumer {
     BooleanConsumer NOP = t -> { /* NOP */ };
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @return The NOP singleton.
      */

src/main/java/org/apache/commons/lang3/function/FailableBiConsumer.java

@@ -36,7 +36,7 @@ public interface FailableBiConsumer<T, U, E extends Throwable> {
     FailableBiConsumer NOP = (t, u) -> { /* NOP */ };
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> Consumed type 1.
      * @param <U> Consumed type 2.

src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java

@@ -38,7 +38,7 @@ public interface FailableBiFunction<T, U, R, E extends Throwable> {
     FailableBiFunction NOP = (t, u) -> null;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> Consumed type 1.
      * @param <U> Consumed type 2.

src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java

@@ -40,7 +40,7 @@ public interface FailableBiPredicate<T, U, E extends Throwable> {
     FailableBiPredicate TRUE = (t, u) -> true;
 
     /**
-     * Returns The FALSE singleton.
+     * Returns the FALSE singleton.
      *
      * @param <T> Consumed type 1.
      * @param <U> Consumed type 2.
@@ -53,7 +53,7 @@ static <T, U, E extends Throwable> FailableBiPredicate<T, U, E> falsePredicate()
     }
 
     /**
-     * Returns The TRUE singleton.
+     * Returns the TRUE singleton.
      *
      * @param <T> Consumed type 1.
      * @param <U> Consumed type 2.

src/main/java/org/apache/commons/lang3/function/FailableConsumer.java

@@ -40,7 +40,7 @@ public interface FailableConsumer<T, E extends Throwable> {
     FailableConsumer NOP = Function.identity()::apply;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> Consumed type 1.
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableDoubleConsumer.java

@@ -34,7 +34,7 @@ public interface FailableDoubleConsumer<E extends Throwable> {
     FailableDoubleConsumer NOP = t -> { /* NOP */ };
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java

@@ -34,7 +34,7 @@ public interface FailableDoubleFunction<R, E extends Throwable> {
     FailableDoubleFunction NOP = t -> null;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <R> Return type.
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableDoublePredicate.java

@@ -38,7 +38,7 @@ public interface FailableDoublePredicate<E extends Throwable> {
     FailableDoublePredicate TRUE = t -> true;
 
     /**
-     * Returns The FALSE singleton.
+     * Returns the FALSE singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.
@@ -49,7 +49,7 @@ static <E extends Throwable> FailableDoublePredicate<E> falsePredicate() {
     }
 
     /**
-     * Returns The TRUE singleton.
+     * Returns the TRUE singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java

@@ -33,7 +33,7 @@ public interface FailableDoubleToIntFunction<E extends Throwable> {
     FailableDoubleToIntFunction NOP = t -> 0;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java

@@ -33,7 +33,7 @@ public interface FailableDoubleToLongFunction<E extends Throwable> {
     FailableDoubleToLongFunction NOP = t -> 0;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java

@@ -43,7 +43,7 @@ static <E extends Throwable> FailableDoubleUnaryOperator<E> identity() {
     }
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableFunction.java

@@ -61,7 +61,7 @@ static <T, E extends Throwable> FailableFunction<T, T, E> identity() {
     }
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> Consumed type.
      * @param <R> Return type.

src/main/java/org/apache/commons/lang3/function/FailableIntConsumer.java

@@ -34,7 +34,7 @@ public interface FailableIntConsumer<E extends Throwable> {
     FailableIntConsumer NOP = t -> { /* NOP */ };
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java

@@ -34,7 +34,7 @@ public interface FailableIntFunction<R, E extends Throwable> {
     FailableIntFunction NOP = t -> null;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <R> Return type.
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableIntPredicate.java

@@ -38,7 +38,7 @@ public interface FailableIntPredicate<E extends Throwable> {
     FailableIntPredicate TRUE = t -> true;
 
     /**
-     * Returns The FALSE singleton.
+     * Returns the FALSE singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.
@@ -49,7 +49,7 @@ static <E extends Throwable> FailableIntPredicate<E> falsePredicate() {
     }
 
     /**
-     * Returns The TRUE singleton.
+     * Returns the TRUE singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java

@@ -33,7 +33,7 @@ public interface FailableIntToDoubleFunction<E extends Throwable> {
     FailableIntToDoubleFunction NOP = t -> 0d;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableIntToFloatFunction.java

@@ -33,7 +33,7 @@ public interface FailableIntToFloatFunction<E extends Throwable> {
     FailableIntToFloatFunction NOP = t -> 0f;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java

@@ -33,7 +33,7 @@ public interface FailableIntToLongFunction<E extends Throwable> {
     FailableIntToLongFunction NOP = t -> 0L;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java

@@ -43,7 +43,7 @@ static <E extends Throwable> FailableIntUnaryOperator<E> identity() {
     }
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableLongConsumer.java

@@ -34,7 +34,7 @@ public interface FailableLongConsumer<E extends Throwable> {
     FailableLongConsumer NOP = t -> { /* NOP */ };
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java

@@ -34,7 +34,7 @@ public interface FailableLongFunction<R, E extends Throwable> {
     FailableLongFunction NOP = t -> null;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <R> Return type.
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java

@@ -38,7 +38,7 @@ public interface FailableLongPredicate<E extends Throwable> {
     FailableLongPredicate TRUE = t -> true;
 
     /**
-     * Returns The FALSE singleton.
+     * Returns the FALSE singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.
@@ -49,7 +49,7 @@ static <E extends Throwable> FailableLongPredicate<E> falsePredicate() {
     }
 
     /**
-     * Returns The TRUE singleton.
+     * Returns the TRUE singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java

@@ -33,7 +33,7 @@ public interface FailableLongToDoubleFunction<E extends Throwable> {
     FailableLongToDoubleFunction NOP = t -> 0d;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java

@@ -33,7 +33,7 @@ public interface FailableLongToIntFunction<E extends Throwable> {
     FailableLongToIntFunction NOP = t -> 0;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java

@@ -43,7 +43,7 @@ static <E extends Throwable> FailableLongUnaryOperator<E> identity() {
     }
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <E> The kind of thrown exception or error.
      * @return The NOP singleton.

src/main/java/org/apache/commons/lang3/function/FailableObjDoubleConsumer.java

@@ -34,7 +34,7 @@ public interface FailableObjDoubleConsumer<T, E extends Throwable> {
     FailableObjDoubleConsumer NOP = (t, u) -> { /* NOP */ };
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the object argument to the operation.
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableObjIntConsumer.java

@@ -34,7 +34,7 @@ public interface FailableObjIntConsumer<T, E extends Throwable> {
     FailableObjIntConsumer NOP = (t, u) -> { /* NOP */ };
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the object argument to the operation.
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableObjLongConsumer.java

@@ -34,7 +34,7 @@ public interface FailableObjLongConsumer<T, E extends Throwable> {
     FailableObjLongConsumer NOP = (t, u) -> { /* NOP */ };
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the object argument to the operation.
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailablePredicate.java

@@ -39,7 +39,7 @@ public interface FailablePredicate<T, E extends Throwable> {
     FailablePredicate TRUE = t -> true;
 
     /**
-     * Returns The FALSE singleton.
+     * Returns the FALSE singleton.
      *
      * @param <T> Predicate type.
      * @param <E> The kind of thrown exception or error.
@@ -51,7 +51,7 @@ static <T, E extends Throwable> FailablePredicate<T, E> falsePredicate() {
     }
 
     /**
-     * Returns The TRUE singleton.
+     * Returns the TRUE singleton.
      *
      * @param <T> Predicate type.
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java

@@ -35,7 +35,7 @@ public interface FailableToDoubleBiFunction<T, U, E extends Throwable> {
     FailableToDoubleBiFunction NOP = (t, u) -> 0d;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the first argument to the function
      * @param <U> the type of the second argument to the function

src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java

@@ -34,7 +34,7 @@ public interface FailableToDoubleFunction<T, E extends Throwable> {
     FailableToDoubleFunction NOP = t -> 0d;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the argument to the function
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java

@@ -35,7 +35,7 @@ public interface FailableToIntBiFunction<T, U, E extends Throwable> {
     FailableToIntBiFunction NOP = (t, u) -> 0;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the first argument to the function
      * @param <U> the type of the second argument to the function

src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java

@@ -34,7 +34,7 @@ public interface FailableToIntFunction<T, E extends Throwable> {
     FailableToIntFunction NOP = t -> 0;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the argument to the function
      * @param <E> The kind of thrown exception or error.

src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java

@@ -35,7 +35,7 @@ public interface FailableToLongBiFunction<T, U, E extends Throwable> {
     FailableToLongBiFunction NOP = (t, u) -> 0;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the first argument to the function
      * @param <U> the type of the second argument to the function

src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java

@@ -34,7 +34,7 @@ public interface FailableToLongFunction<T, E extends Throwable> {
     FailableToLongFunction NOP = t -> 0L;
 
     /**
-     * Returns The NOP singleton.
+     * Returns the NOP singleton.
      *
      * @param <T> the type of the argument to the function
      * @param <E> The kind of thrown exception or error.