This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new 511590791 Javadoc
511590791 is described below
commit 5115907915f4f857f03c4e9b418a87d755e0e6f7
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Jun 30 14:03:16 2026 +0000
Javadoc
---
.../org/apache/commons/lang3/AppendableJoiner.java | 4 +-
.../java/org/apache/commons/lang3/ArrayFill.java | 2 +-
.../java/org/apache/commons/lang3/ArraySorter.java | 4 +-
.../java/org/apache/commons/lang3/ArrayUtils.java | 24 +++----
.../java/org/apache/commons/lang3/EnumUtils.java | 12 ++--
.../java/org/apache/commons/lang3/Functions.java | 42 ++++++------
.../java/org/apache/commons/lang3/ObjectUtils.java | 20 +++---
src/main/java/org/apache/commons/lang3/Range.java | 12 ++--
.../apache/commons/lang3/SerializationUtils.java | 2 +-
.../java/org/apache/commons/lang3/Streams.java | 6 +-
.../java/org/apache/commons/lang3/Validate.java | 50 +++++++--------
.../commons/lang3/builder/AbstractSupplier.java | 2 +-
.../org/apache/commons/lang3/builder/Builder.java | 2 +-
.../apache/commons/lang3/builder/DiffBuilder.java | 2 +-
.../org/apache/commons/lang3/builder/Diffable.java | 2 +-
.../commons/lang3/builder/ToStringBuilder.java | 2 +-
.../commons/lang3/compare/ComparableUtils.java | 2 +-
.../lang3/concurrent/AbstractCircuitBreaker.java | 2 +-
.../concurrent/AbstractConcurrentInitializer.java | 2 +-
.../lang3/concurrent/AtomicInitializer.java | 4 +-
.../lang3/concurrent/AtomicSafeInitializer.java | 4 +-
.../lang3/concurrent/BackgroundInitializer.java | 4 +-
.../concurrent/CallableBackgroundInitializer.java | 2 +-
.../commons/lang3/concurrent/CircuitBreaker.java | 2 +-
.../commons/lang3/concurrent/Computable.java | 4 +-
.../lang3/concurrent/ConcurrentInitializer.java | 2 +-
.../commons/lang3/concurrent/ConcurrentUtils.java | 20 +++---
.../lang3/concurrent/ConstantInitializer.java | 2 +-
.../commons/lang3/concurrent/LazyInitializer.java | 4 +-
.../apache/commons/lang3/concurrent/Memoizer.java | 4 +-
.../lang3/concurrent/locks/LockingVisitors.java | 22 +++----
.../commons/lang3/event/EventListenerSupport.java | 4 +-
.../commons/lang3/exception/ExceptionUtils.java | 6 +-
.../apache/commons/lang3/function/Failable.java | 74 +++++++++++-----------
.../commons/lang3/function/FailableBiFunction.java | 2 +-
.../commons/lang3/function/FailableConsumer.java | 4 +-
.../commons/lang3/function/FailableFunction.java | 6 +-
.../lang3/function/FailableObjDoubleConsumer.java | 4 +-
.../lang3/function/FailableObjIntConsumer.java | 4 +-
.../lang3/function/FailableObjLongConsumer.java | 4 +-
.../lang3/function/FailableToBooleanFunction.java | 4 +-
.../lang3/function/FailableToDoubleBiFunction.java | 8 +--
.../lang3/function/FailableToDoubleFunction.java | 4 +-
.../lang3/function/FailableToIntBiFunction.java | 8 +--
.../lang3/function/FailableToIntFunction.java | 4 +-
.../lang3/function/FailableToLongBiFunction.java | 8 +--
.../lang3/function/FailableToLongFunction.java | 4 +-
.../commons/lang3/function/MethodInvokers.java | 28 ++++----
.../apache/commons/lang3/function/Predicates.java | 4 +-
.../apache/commons/lang3/function/Suppliers.java | 2 +-
.../lang3/function/ToBooleanBiFunction.java | 4 +-
.../apache/commons/lang3/function/TriFunction.java | 10 +--
.../org/apache/commons/lang3/mutable/Mutable.java | 2 +-
.../commons/lang3/mutable/MutableObject.java | 2 +-
.../apache/commons/lang3/reflect/TypeLiteral.java | 2 +-
.../org/apache/commons/lang3/reflect/Typed.java | 2 +-
.../commons/lang3/stream/LangCollectors.java | 4 +-
.../org/apache/commons/lang3/stream/Streams.java | 30 ++++-----
.../org/apache/commons/lang3/text/StrLookup.java | 4 +-
.../apache/commons/lang3/text/StrSubstitutor.java | 12 ++--
.../org/apache/commons/lang3/time/DatePrinter.java | 6 +-
.../apache/commons/lang3/time/FastDatePrinter.java | 2 +-
.../apache/commons/lang3/tuple/ImmutablePair.java | 32 +++++-----
.../commons/lang3/tuple/ImmutableTriple.java | 30 ++++-----
.../apache/commons/lang3/tuple/MutablePair.java | 24 +++----
.../apache/commons/lang3/tuple/MutableTriple.java | 24 +++----
.../java/org/apache/commons/lang3/tuple/Pair.java | 20 +++---
.../org/apache/commons/lang3/tuple/Triple.java | 24 +++----
68 files changed, 342 insertions(+), 342 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/AppendableJoiner.java
b/src/main/java/org/apache/commons/lang3/AppendableJoiner.java
index eb19fac24..f4b3776e0 100644
--- a/src/main/java/org/apache/commons/lang3/AppendableJoiner.java
+++ b/src/main/java/org/apache/commons/lang3/AppendableJoiner.java
@@ -73,7 +73,7 @@
* This class is immutable and thread-safe.
* </p>
*
- * @param <T> the type of elements to join.
+ * @param <T> The type of elements to join.
* @see Appendable
* @see StringBuilder
* @see String#join(CharSequence, CharSequence...)
@@ -86,7 +86,7 @@ public final class AppendableJoiner<T> {
/**
* Builds instances of {@link AppendableJoiner}.
*
- * @param <T> the type of elements to join.
+ * @param <T> The type of elements to join.
*/
public static final class Builder<T> implements
Supplier<AppendableJoiner<T>> {
diff --git a/src/main/java/org/apache/commons/lang3/ArrayFill.java
b/src/main/java/org/apache/commons/lang3/ArrayFill.java
index e6b9d95e5..d04491921 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayFill.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayFill.java
@@ -255,7 +255,7 @@ public static <T, E extends Throwable> T[] fill(final T[]
array, final FailableI
/**
* Fills and returns the given array, assigning the given {@code T} value
to each element of the array.
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
* @return the given array.
diff --git a/src/main/java/org/apache/commons/lang3/ArraySorter.java
b/src/main/java/org/apache/commons/lang3/ArraySorter.java
index 17ecc0610..7ad5f4a82 100644
--- a/src/main/java/org/apache/commons/lang3/ArraySorter.java
+++ b/src/main/java/org/apache/commons/lang3/ArraySorter.java
@@ -129,7 +129,7 @@ public static short[] sort(final short[] array) {
/**
* Sorts the given array into ascending order and returns it.
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param array the array to sort (may be null).
* @return the given array.
* @see Arrays#sort(Object[])
@@ -144,7 +144,7 @@ public static <T> T[] sort(final T[] array) {
/**
* Sorts the given array into ascending order and returns it.
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param array the array to sort (may be null).
* @param comparator the comparator to determine the order of the array. A
{@code null} value uses the elements'
* {@link Comparable natural ordering}.
diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
index 3a7dafb80..ca87e7470 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
@@ -782,7 +782,7 @@ public static short[] add(final short[] array, final short
element) {
* ArrayUtils.add(["a", "b"], 3, "c") = ["a", "b", "c"]
* </pre>
*
- * @param <T> the component type of the array.
+ * @param <T> The component type of the array.
* @param array the array to add the element to, may be {@code null}.
* @param index the position of the new object.
* @param element the object to add.
@@ -826,7 +826,7 @@ public static <T> T[] add(final T[] array, final int index,
final T element) {
* ArrayUtils.add(["a", "b"], "c") = ["a", "b", "c"]
* </pre>
*
- * @param <T> the component type of the array.
+ * @param <T> The component type of the array.
* @param array the array to "add" the element to, may be {@code null}.
* @param element the object to add, may be {@code null}.
* @return A new array containing the existing elements plus the new
element
@@ -1125,7 +1125,7 @@ public static short[] addAll(final short[] array1, final
short... array2) {
* ArrayUtils.addAll(["a", "b", "c"], ["1", "2", "3"]) = ["a", "b", "c",
"1", "2", "3"]
* </pre>
*
- * @param <T> the component type of the array.
+ * @param <T> The component type of the array.
* @param array1 the first array whose elements are added to the new
array, may be {@code null}.
* @param array2 the second array whose elements are added to the new
array, may be {@code null}.
* @return The new array, {@code null} if both arrays are {@code null}.
@@ -1407,7 +1407,7 @@ public static short[] addFirst(final short[] array, final
short element) {
* ArrayUtils.addFirst(["a", "b"], "c") = ["c", "a", "b"]
* </pre>
*
- * @param <T> the component type of the array.
+ * @param <T> The component type of the array.
* @param array the array to "add" the element to, may be {@code null}.
* @param element the object to add, may be {@code null}.
* @return A new array containing the existing elements plus the new
element The returned array type will be that of
@@ -3506,7 +3506,7 @@ private static boolean isArrayEmpty(final Object array) {
* ArrayUtils.isArrayIndexValid(["a"], 0) = true
* </pre>
*
- * @param <T> the component type of the array.
+ * @param <T> The component type of the array.
* @param array the array to inspect, may be {@code null}.
* @param index the index of the array to be inspected.
* @return Whether the given index is safely-accessible in the given array.
@@ -3724,7 +3724,7 @@ public static boolean isNotEmpty(final short[] array) {
/**
* Tests whether an array of Objects is not empty and not {@code null}.
*
- * @param <T> the component type of the array
+ * @param <T> The component type of the array
* @param array the array to test.
* @return {@code true} if the array is not empty and not {@code null}.
* @since 2.5
@@ -4054,7 +4054,7 @@ public static boolean isSorted(final short[] array) {
* {@code compareTo} method.
*
* @param array the array to check.
- * @param <T> the datatype of the array to check, it must implement {@link
Comparable}.
+ * @param <T> The datatype of the array to check, it must implement {@link
Comparable}.
* @return whether the array is sorted.
* @since 3.4
*/
@@ -4067,7 +4067,7 @@ public static <T extends Comparable<? super T>> boolean
isSorted(final T[] array
*
* @param array the array to check.
* @param comparator the {@link Comparator} to compare over.
- * @param <T> the datatype of the array.
+ * @param <T> The datatype of the array.
* @return whether the array is sorted.
* @throws NullPointerException if {@code comparator} is {@code null}.
* @since 3.4
@@ -5764,7 +5764,7 @@ public static short[] removeAllOccurences(final short[]
array, final short eleme
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
- * @param <T> the type of object in the array, may be {@code null}.
+ * @param <T> The type of object in the array, may be {@code null}.
* @param array the input array, will not be modified, and may be {@code
null}.
* @param element the element to remove, may be {@code null}.
* @return A new array containing the existing elements except the
occurrences of the specified element.
@@ -5920,7 +5920,7 @@ public static short[] removeAllOccurrences(final short[]
array, final short elem
* {@code null} will be returned if the input array is {@code null}.
* </p>
*
- * @param <T> the type of object in the array, may be {@code null}.
+ * @param <T> The type of object in the array, may be {@code null}.
* @param array the input array, will not be modified, and may be {@code
null}.
* @param element the element to remove, may be {@code null}.
* @return A new array containing the existing elements except the
occurrences of the specified element.
@@ -6229,7 +6229,7 @@ public static short[] removeElement(final short[] array,
final short element) {
* ArrayUtils.removeElement(["a", "b", "a"], "a") = ["b", "a"]
* </pre>
*
- * @param <T> the component type of the array
+ * @param <T> The component type of the array
* @param array the input array, may be {@code null}.
* @param element the element to be removed, may be {@code null}.
* @return A new array containing the existing elements except the first
@@ -6654,7 +6654,7 @@ public static short[] removeElements(final short[] array,
final short... values)
* ArrayUtils.removeElements(["a", "b", "a"], "a", "a") = ["b"]
* </pre>
*
- * @param <T> the component type of the array
+ * @param <T> The component type of the array
* @param array the input array, will not be modified, and may be {@code
null}.
* @param values the values to be removed.
* @return A new array containing the existing elements except the
diff --git a/src/main/java/org/apache/commons/lang3/EnumUtils.java
b/src/main/java/org/apache/commons/lang3/EnumUtils.java
index 513b3140a..710363780 100644
--- a/src/main/java/org/apache/commons/lang3/EnumUtils.java
+++ b/src/main/java/org/apache/commons/lang3/EnumUtils.java
@@ -47,7 +47,7 @@ public class EnumUtils {
/**
* Validate {@code enumClass}.
*
- * @param <E> the type of the enumeration.
+ * @param <E> The type of the enumeration.
* @param enumClass to check.
* @return {@code enumClass}.
* @throws NullPointerException if {@code enumClass} is {@code null}.
@@ -63,7 +63,7 @@ private static <E extends Enum<E>> Class<E> asEnum(final
Class<E> enumClass) {
/**
* Validate that {@code enumClass} is compatible with representation in a
{@code long}.
*
- * @param <E> the type of the enumeration.
+ * @param <E> The type of the enumeration.
* @param enumClass to check.
* @return {@code enumClass}.
* @throws NullPointerException if {@code enumClass} is {@code null}.
@@ -194,7 +194,7 @@ public static <E extends Enum<E>> long[]
generateBitVectors(final Class<E> enumC
* <p>This method differs from {@link Enum#valueOf} in that it does not
throw an exception
* for an invalid enum name.</p>
*
- * @param <E> the type of the enumeration.
+ * @param <E> The type of the enumeration.
* @param enumClass the class of the enum to query, not null.
* @param enumName the enum name, null returns null.
* @return the enum, null if not found.
@@ -209,7 +209,7 @@ public static <E extends Enum<E>> E getEnum(final Class<E>
enumClass, final Stri
* <p>This method differs from {@link Enum#valueOf} in that it does not
throw an exception
* for an invalid enum name.</p>
*
- * @param <E> the type of the enumeration.
+ * @param <E> The type of the enumeration.
* @param enumClass the class of the enum to query, null returns default
enum.
* @param enumName the enum name, null returns default enum.
* @param defaultEnum the default enum.
@@ -266,7 +266,7 @@ public static <E extends Enum<E>> E getEnumIgnoreCase(final
Class<E> enumClass,
*
* <p>This method is useful when you need a list of enums rather than an
array.</p>
*
- * @param <E> the type of the enumeration.
+ * @param <E> The type of the enumeration.
* @param enumClass the class of the enum to query, not null.
* @return the modifiable list of enums, never null.
*/
@@ -279,7 +279,7 @@ public static <E extends Enum<E>> List<E> getEnumList(final
Class<E> enumClass)
*
* <p>This method is useful when you need a map of enums by name.</p>
*
- * @param <E> the type of the enumeration.
+ * @param <E> The type of the enumeration.
* @param enumClass the class of the enum to query, not null.
* @return the modifiable map of enum names to enums, never null.
*/
diff --git a/src/main/java/org/apache/commons/lang3/Functions.java
b/src/main/java/org/apache/commons/lang3/Functions.java
index 70f0aaf39..ae14bcea5 100644
--- a/src/main/java/org/apache/commons/lang3/Functions.java
+++ b/src/main/java/org/apache/commons/lang3/Functions.java
@@ -291,7 +291,7 @@ public interface FailableSupplier<R, T extends Throwable> {
* @param object2 the second object to consume by {@code consumer}
* @param <O1> the type of the first argument the consumer accepts
* @param <O2> the type of the second argument the consumer accepts
- * @param <T> the type of checked exception the consumer may throw
+ * @param <T> The type of checked exception the consumer may throw
*/
public static <O1, O2, T extends Throwable> void accept(final
FailableBiConsumer<O1, O2, T> consumer,
final O1 object1, final O2 object2) {
@@ -303,8 +303,8 @@ public static <O1, O2, T extends Throwable> void
accept(final FailableBiConsumer
*
* @param consumer the consumer to consume
* @param object the object to consume by {@code consumer}
- * @param <O> the type the consumer accepts
- * @param <T> the type of checked exception the consumer may throw
+ * @param <O> The type the consumer accepts
+ * @param <T> The type of checked exception the consumer may throw
*/
public static <O, T extends Throwable> void accept(final
FailableConsumer<O, T> consumer, final O object) {
run(() -> consumer.accept(object));
@@ -318,8 +318,8 @@ public static <O, T extends Throwable> void accept(final
FailableConsumer<O, T>
* @param input2 the second input to apply {@code function} on
* @param <O1> the type of the first argument the function accepts
* @param <O2> the type of the second argument the function accepts
- * @param <O> the return type of the function
- * @param <T> the type of checked exception the function may throw
+ * @param <O> The return type of the function
+ * @param <T> The type of checked exception the function may throw
* @return the value returned from the function
*/
public static <O1, O2, O, T extends Throwable> O apply(final
FailableBiFunction<O1, O2, O, T> function,
@@ -332,9 +332,9 @@ public static <O1, O2, O, T extends Throwable> O
apply(final FailableBiFunction<
*
* @param function the function to apply
* @param input the input to apply {@code function} on
- * @param <I> the type of the argument the function accepts
- * @param <O> the return type of the function
- * @param <T> the type of checked exception the function may throw
+ * @param <I> The type of the argument the function accepts
+ * @param <O> The return type of the function
+ * @param <T> The type of checked exception the function may throw
* @return the value returned from the function
*/
public static <I, O, T extends Throwable> O apply(final
FailableFunction<I, O, T> function, final I input) {
@@ -359,7 +359,7 @@ public static <O1, O2> BiConsumer<O1, O2>
asBiConsumer(final FailableBiConsumer<
*
* @param <O1> the type of the first argument of the input of the functions
* @param <O2> the type of the second argument of the input of the
functions
- * @param <O> the type of the output of the functions
+ * @param <O> The type of the output of the functions
* @param function a {@link FailableBiFunction}
* @return a standard {@link BiFunction}
* @since 3.10
@@ -384,7 +384,7 @@ public static <O1, O2> BiPredicate<O1, O2>
asBiPredicate(final FailableBiPredica
/**
* Converts the given {@link FailableCallable} into a standard {@link
Callable}.
*
- * @param <O> the type used by the callables
+ * @param <O> The type used by the callables
* @param callable a {@link FailableCallable}
* @return a standard {@link Callable}
* @since 3.10
@@ -396,7 +396,7 @@ public static <O> Callable<O> asCallable(final
FailableCallable<O, ?> callable)
/**
* Converts the given {@link FailableConsumer} into a standard {@link
Consumer}.
*
- * @param <I> the type used by the consumers
+ * @param <I> The type used by the consumers
* @param consumer a {@link FailableConsumer}
* @return a standard {@link Consumer}
* @since 3.10
@@ -408,8 +408,8 @@ public static <I> Consumer<I> asConsumer(final
FailableConsumer<I, ?> consumer)
/**
* Converts the given {@link FailableFunction} into a standard {@link
Function}.
*
- * @param <I> the type of the input of the functions
- * @param <O> the type of the output of the functions
+ * @param <I> The type of the input of the functions
+ * @param <O> The type of the output of the functions
* @param function a {code FailableFunction}
* @return a standard {@link Function}
* @since 3.10
@@ -421,7 +421,7 @@ public static <I, O> Function<I, O> asFunction(final
FailableFunction<I, O, ?> f
/**
* Converts the given {@link FailablePredicate} into a standard {@link
Predicate}.
*
- * @param <I> the type used by the predicates
+ * @param <I> The type used by the predicates
* @param predicate a {@link FailablePredicate}
* @return a standard {@link Predicate}
* @since 3.10
@@ -444,7 +444,7 @@ public static Runnable asRunnable(final FailableRunnable<?>
runnable) {
/**
* Converts the given {@link FailableSupplier} into a standard {@link
Supplier}.
*
- * @param <O> the type supplied by the suppliers
+ * @param <O> The type supplied by the suppliers
* @param supplier a {@link FailableSupplier}
* @return a standard {@link Supplier}
* @since 3.10
@@ -457,8 +457,8 @@ public static <O> Supplier<O> asSupplier(final
FailableSupplier<O, ?> supplier)
* Calls a callable and rethrows any exception as a {@link
RuntimeException}.
*
* @param callable the callable to call
- * @param <O> the return type of the callable
- * @param <T> the type of checked exception the callable may throw
+ * @param <O> The return type of the callable
+ * @param <T> The type of checked exception the callable may throw
* @return the value returned from the callable
*/
public static <O, T extends Throwable> O call(final FailableCallable<O, T>
callable) {
@@ -534,7 +534,7 @@ public static RuntimeException rethrow(final Throwable
throwable) {
* Runs a runnable and rethrows any exception as a {@link
RuntimeException}.
*
* @param runnable The runnable to run
- * @param <T> the type of checked exception the runnable may throw
+ * @param <T> The type of checked exception the runnable may throw
*/
public static <T extends Throwable> void run(final FailableRunnable<T>
runnable) {
try {
@@ -583,7 +583,7 @@ public static <O> FailableStream<O> stream(final Stream<O>
stream) {
* @param object2 the second input to test by {@code predicate}
* @param <O1> the type of the first argument the predicate tests
* @param <O2> the type of the second argument the predicate tests
- * @param <T> the type of checked exception the predicate may throw
+ * @param <T> The type of checked exception the predicate may throw
* @return the boolean value returned by the predicate
*/
public static <O1, O2, T extends Throwable> boolean test(final
FailableBiPredicate<O1, O2, T> predicate,
@@ -596,8 +596,8 @@ public static <O1, O2, T extends Throwable> boolean
test(final FailableBiPredica
*
* @param predicate the predicate to test
* @param object the input to test by {@code predicate}
- * @param <O> the type of argument the predicate tests
- * @param <T> the type of checked exception the predicate may throw
+ * @param <O> The type of argument the predicate tests
+ * @param <T> The type of checked exception the predicate may throw
* @return the boolean value returned by the predicate
*/
public static <O, T extends Throwable> boolean test(final
FailablePredicate<O, T> predicate, final O object) {
diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java
b/src/main/java/org/apache/commons/lang3/ObjectUtils.java
index 97e7e63ce..f4b9f67bb 100644
--- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java
@@ -223,7 +223,7 @@ public static boolean anyNull(final Object... values) {
/**
* Clones an object.
*
- * @param <T> the type of the object.
+ * @param <T> The type of the object.
* @param obj the object to clone, null returns null.
* @return the clone if the object implements {@link Cloneable} otherwise
{@code null}.
* @throws CloneFailedException if the object is cloneable and the clone
operation fails.
@@ -266,7 +266,7 @@ public static <T> T clone(final T obj) {
* have to change.
* </p>
*
- * @param <T> the type of the object.
+ * @param <T> The type of the object.
* @param obj the object to clone, null returns null.
* @return the clone if the object implements {@link Cloneable} otherwise
the object itself.
* @throws CloneFailedException if the object is cloneable and the clone
operation fails.
@@ -464,7 +464,7 @@ public static short CONST(final short v) {
*
* This way any jars that refer to this field do not have to recompile
themselves if the field's value changes at some future date.
*
- * @param <T> the Object type.
+ * @param <T> The Object type.
* @param v the genericized Object value to return (typically a String).
* @return the genericized Object v, unchanged (typically a String).
* @since 3.2
@@ -526,7 +526,7 @@ public static short CONST_SHORT(final int v) {
* ObjectUtils.defaultIfNull(Boolean.TRUE, *) = Boolean.TRUE
* </pre>
*
- * @param <T> the type of the object.
+ * @param <T> The type of the object.
* @param object the {@link Object} to test, may be {@code null}.
* @param defaultValue the default value to return, may be {@code null}.
* @return {@code object} if it is not {@code null}, defaultValue
otherwise.
@@ -581,7 +581,7 @@ public static boolean equals(final Object object1, final
Object object2) {
* ObjectUtils.firstNonNull() = null
* </pre>
*
- * @param <T> the component type of the array.
+ * @param <T> The component type of the array.
* @param values the values to test, may be {@code null} or empty.
* @return the first value from {@code values} which is not {@code null},
* or {@code null} if there are no non-null values.
@@ -654,7 +654,7 @@ public static <T> T getFirstNonNull(final Supplier<T>...
suppliers) {
* See also {@link Consumers#accept(Consumer, Object)} and {@link
Suppliers#get(Supplier)}.
* </p>
*
- * @param <T> the type of the object.
+ * @param <T> The type of the object.
* @param object the {@link Object} to test, may be {@code null}.
* @param defaultSupplier the default value to return, may be {@code null}.
* @return {@code object} if it is not {@code null}, {@code
defaultValueSupplier.get()} otherwise.
@@ -681,7 +681,7 @@ public static <T> T getIfNull(final T object, final
Supplier<T> defaultSupplier)
* See also {@link Consumers#accept(Consumer, Object)} and {@link
Suppliers#get(Supplier)}.
* </p>
*
- * @param <T> the type of the object.
+ * @param <T> The type of the object.
* @param object the {@link Object} to test, may be {@code null}.
* @param defaultValue the default value to return, may be {@code null}.
* @return {@code object} if it is not {@code null}, defaultValue
otherwise.
@@ -1174,7 +1174,7 @@ public static boolean notEqual(final Object object1,
final Object object2) {
* }
* </pre>
*
- * @param <T> the type of the reference.
+ * @param <T> The type of the reference.
* @param obj the object reference to check for nullity.
* @return {@code obj} if not {@code null}.
* @throws NullPointerException if {@code obj} is {@code null}.
@@ -1196,7 +1196,7 @@ public static <T> T requireNonEmpty(final T obj) {
* }
* </pre>
*
- * @param <T> the type of the reference.
+ * @param <T> The type of the reference.
* @param obj the object reference to check for nullity.
* @param message the exception message.
* @return {@code obj} if not {@code null}.
@@ -1303,7 +1303,7 @@ public static String toString(final Supplier<Object> obj,
final Supplier<String>
* ObjectUtils.toString(Boolean.TRUE, () -> expensive()) = "true"
* }</pre>
*
- * @param <T> the obj type (used to provide better source compatibility in
3.14.0).
+ * @param <T> The obj type (used to provide better source compatibility in
3.14.0).
* @param obj the Object to {@code toString}, may be null.
* @param supplier the Supplier of String used on {@code null} input, may
be null.
* @return the passed in Object's toString, or {@code nullStr} if {@code
null} input.
diff --git a/src/main/java/org/apache/commons/lang3/Range.java
b/src/main/java/org/apache/commons/lang3/Range.java
index 0d6bb2680..ca3d6c778 100644
--- a/src/main/java/org/apache/commons/lang3/Range.java
+++ b/src/main/java/org/apache/commons/lang3/Range.java
@@ -71,7 +71,7 @@ public int compare(final Object obj1, final Object obj2) {
* <p>The arguments may be passed in the order (min, max) or (max, min).
* The getMinimum and getMaximum methods will return the correct
values.</p>
*
- * @param <T> the type of the elements in this range.
+ * @param <T> The type of the elements in this range.
* @param fromInclusive the first value that defines the edge of the
range, inclusive.
* @param toInclusive the second value that defines the edge of the
range, inclusive.
* @return the range object, not null.
@@ -94,7 +94,7 @@ public static <T extends Comparable<? super T>> Range<T>
between(final T fromInc
* <p>The arguments may be passed in the order (min, max) or (max, min).
* The getMinimum and getMaximum methods will return the correct
values.</p>
*
- * @param <T> the type of the elements in this range.
+ * @param <T> The type of the elements in this range.
* @param fromInclusive the first value that defines the edge of the
range, inclusive.
* @param toInclusive the second value that defines the edge of the
range, inclusive.
* @param comparator the comparator to be used, null for natural ordering.
@@ -120,7 +120,7 @@ private static int hash(final Object value1, final Object
value2) {
* <p>The range uses the natural ordering of the elements to determine
where
* values lie in the range.</p>
*
- * @param <T> the type of the elements in this range.
+ * @param <T> The type of the elements in this range.
* @param element the value to use for this range, not null.
* @return the range object, not null.
* @throws NullPointerException if the element is null.
@@ -137,7 +137,7 @@ public static <T extends Comparable<? super T>> Range<T>
is(final T element) {
* <p>The range uses the specified {@link Comparator} to determine where
* values lie in the range.</p>
*
- * @param <T> the type of the elements in this range.
+ * @param <T> The type of the elements in this range.
* @param element the value to use for this range, must not be {@code
null}.
* @param comparator the comparator to be used, null for natural ordering.
* @return the range object, not null.
@@ -157,7 +157,7 @@ public static <T> Range<T> is(final T element, final
Comparator<T> comparator) {
* <p>The arguments may be passed in the order (min, max) or (max, min).
* The getMinimum and getMaximum methods will return the correct
values.</p>
*
- * @param <T> the type of the elements in this range.
+ * @param <T> The type of the elements in this range.
* @param fromInclusive the first value that defines the edge of the
range, inclusive.
* @param toInclusive the second value that defines the edge of the
range, inclusive.
* @return the range object, not null.
@@ -178,7 +178,7 @@ public static <T extends Comparable<? super T>> Range<T>
of(final T fromInclusiv
* <p>The arguments may be passed in the order (min, max) or (max, min).
* The getMinimum and getMaximum methods will return the correct
values.</p>
*
- * @param <T> the type of the elements in this range.
+ * @param <T> The type of the elements in this range.
* @param fromInclusive the first value that defines the edge of the
range, inclusive.
* @param toInclusive the second value that defines the edge of the
range, inclusive.
* @param comparator the comparator to be used, null for natural ordering.
diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
index 4b1fea491..896da5169 100644
--- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
@@ -230,7 +230,7 @@ public static <T> T requireNonNull(final T obj, final
String message) throws Inv
/**
* Performs a serialization roundtrip. Serializes and deserializes the
given object, great for testing objects that implement {@link Serializable}.
*
- * @param <T> the type of the object involved.
+ * @param <T> The type of the object involved.
* @param obj the object to roundtrip.
* @return the serialized and deserialized object.
* @see <a
href="https://docs.oracle.com/en/java/javase/25/docs/specs/serialization/";>Java
Object Serialization Specification</a>
diff --git a/src/main/java/org/apache/commons/lang3/Streams.java
b/src/main/java/org/apache/commons/lang3/Streams.java
index c58797639..b3a9c3bdf 100644
--- a/src/main/java/org/apache/commons/lang3/Streams.java
+++ b/src/main/java/org/apache/commons/lang3/Streams.java
@@ -257,8 +257,8 @@ protected void assertNotTerminated() {
*
Collectors.groupingBy(Person::getCity)));
* }</pre>
*
- * @param <R> the type of the result.
- * @param <A> the intermediate accumulation type of the {@link
Collector}.
+ * @param <R> The type of the result.
+ * @param <A> The intermediate accumulation type of the {@link
Collector}.
* @param collector the {@link Collector} describing the reduction.
* @return the result of the reduction.
* @see #collect(Supplier, BiConsumer, BiConsumer)
@@ -559,7 +559,7 @@ public static <O> FailableStream<O> stream(final Stream<O>
stream) {
* new array.
*
* @param elementType Type of an element in the array.
- * @param <O> the type of the input elements.
+ * @param <O> The type of the input elements.
* @return a {@link Collector} which collects all the input elements into
an
* array, in encounter order.
*/
diff --git a/src/main/java/org/apache/commons/lang3/Validate.java
b/src/main/java/org/apache/commons/lang3/Validate.java
index 37ba0af82..69893973c 100644
--- a/src/main/java/org/apache/commons/lang3/Validate.java
+++ b/src/main/java/org/apache/commons/lang3/Validate.java
@@ -166,7 +166,7 @@ public static void exclusiveBetween(final long start, final
long end, final long
*
* <pre>Validate.exclusiveBetween(0, 2, 1);</pre>
*
- * @param <T> the type of the argument object.
+ * @param <T> The type of the argument object.
* @param start the exclusive start value, not null.
* @param end the exclusive end value, not null.
* @param value the object to validate, not null.
@@ -188,7 +188,7 @@ public static <T> void exclusiveBetween(final T start,
final T end, final Compar
*
* <pre>Validate.exclusiveBetween(0, 2, 1, "Not in boundaries");</pre>
*
- * @param <T> the type of the argument object.
+ * @param <T> The type of the argument object.
* @param start the exclusive start value, not null.
* @param end the exclusive end value, not null.
* @param value the object to validate, not null.
@@ -343,7 +343,7 @@ public static void inclusiveBetween(final long start, final
long end, final long
*
* <pre>Validate.inclusiveBetween(0, 2, 1);</pre>
*
- * @param <T> the type of the argument object.
+ * @param <T> The type of the argument object.
* @param start the inclusive start value, not null.
* @param end the inclusive end value, not null.
* @param value the object to validate, not null.
@@ -365,7 +365,7 @@ public static <T> void inclusiveBetween(final T start,
final T end, final Compar
*
* <pre>Validate.inclusiveBetween(0, 2, 1, "Not in boundaries");</pre>
*
- * @param <T> the type of the argument object.
+ * @param <T> The type of the argument object.
* @param start the inclusive start value, not null.
* @param end the inclusive end value, not null.
* @param value the object to validate, not null.
@@ -656,7 +656,7 @@ public static void matchesPattern(final CharSequence input,
final String pattern
* exception is "The validated iterable contains null element at
index:
* " followed by the index.</p>
*
- * @param <T> the iterable type.
+ * @param <T> The iterable type.
* @param iterable the iterable to check, validated not null by this
method.
* @return the validated iterable (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}.
@@ -681,7 +681,7 @@ public static <T extends Iterable<?>> T
noNullElements(final T iterable) {
* index of the invalid element is appended to the {@code values}
* argument.</p>
*
- * @param <T> the iterable type.
+ * @param <T> The iterable type.
* @param iterable the iterable to check, validated not null by this
method.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
* @param values the optional values for the formatted exception message,
null array not recommended.
@@ -715,7 +715,7 @@ public static <T extends Iterable<?>> T
noNullElements(final T iterable, final S
* exception is "The validated array contains null element at index:
* " followed by the index.</p>
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param array the array to check, validated not null by this method.
* @return the validated array (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}.
@@ -740,7 +740,7 @@ public static <T> T[] noNullElements(final T[] array) {
* index of the invalid element is appended to the {@code values}
* argument.</p>
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param array the array to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
* @param values the optional values for the formatted exception message,
null array not recommended.
@@ -770,7 +770,7 @@ public static <T> T[] noNullElements(final T[] array, final
String message, fina
* <p>The message in the exception is "The validated character
* sequence is blank".
*
- * @param <T> the character sequence type.
+ * @param <T> The character sequence type.
* @param chars the character sequence to check, validated not null by
this method.
* @return the validated character sequence (never {@code null} method for
chaining).
* @throws NullPointerException if the character sequence is {@code null}.
@@ -818,7 +818,7 @@ public static <T extends CharSequence> T notBlank(final T
chars, final String me
* <p>The message in the exception is "The validated collection is
* empty".
*
- * @param <T> the collection type.
+ * @param <T> The collection type.
* @param collection the collection to check, validated not null by this
method.
* @return the validated collection (never {@code null} method for
chaining).
* @throws NullPointerException if the collection is {@code null}.
@@ -838,7 +838,7 @@ public static <T extends Collection<?>> T notEmpty(final T
collection) {
* <p>The message in the exception is "The validated map is
* empty".
*
- * @param <T> the map type.
+ * @param <T> The map type.
* @param map the map to check, validated not null by this method.
* @return the validated map (never {@code null} method for chaining).
* @throws NullPointerException if the map is {@code null}.
@@ -859,7 +859,7 @@ public static <T extends Collection<?>> T notEmpty(final T
collection) {
* <p>The message in the exception is "The validated
* character sequence is empty".
*
- * @param <T> the character sequence type.
+ * @param <T> The character sequence type.
* @param chars the character sequence to check, validated not null by
this method.
* @return the validated character sequence (never {@code null} method for
chaining).
* @throws NullPointerException if the character sequence is {@code null}.
@@ -877,7 +877,7 @@ public static <T extends CharSequence> T notEmpty(final T
chars) {
*
* <pre>Validate.notEmpty(myCollection, "The collection must not be
empty");</pre>
*
- * @param <T> the collection type.
+ * @param <T> The collection type.
* @param collection the collection to check, validated not null by this
method.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
* @param values the optional values for the formatted exception message,
null array not recommended.
@@ -901,7 +901,7 @@ public static <T extends Collection<?>> T notEmpty(final T
collection, final Str
*
* <pre>Validate.notEmpty(myMap, "The map must not be empty");</pre>
*
- * @param <T> the map type.
+ * @param <T> The map type.
* @param map the map to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
* @param values the optional values for the formatted exception message,
null array not recommended.
@@ -925,7 +925,7 @@ public static <T extends Collection<?>> T notEmpty(final T
collection, final Str
*
* <pre>Validate.notEmpty(myString, "The string must not be empty");</pre>
*
- * @param <T> the character sequence type.
+ * @param <T> The character sequence type.
* @param chars the character sequence to check, validated not null by
this method.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
* @param values the optional values for the formatted exception message,
null array not recommended.
@@ -951,7 +951,7 @@ public static <T extends CharSequence> T notEmpty(final T
chars, final String me
* <p>The message in the exception is "The validated array is
* empty".
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param array the array to check, validated not null by this method.
* @return the validated array (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}.
@@ -969,7 +969,7 @@ public static <T> T[] notEmpty(final T[] array) {
*
* <pre>Validate.notEmpty(myArray, "The array must not be empty");</pre>
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param array the array to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
* @param values the optional values for the formatted exception message,
null array not recommended.
@@ -1032,7 +1032,7 @@ public static void notNaN(final double value, final
String message, final Object
* <p>The message of the exception is "The validated object is
* null".
*
- * @param <T> the object type.
+ * @param <T> The object type.
* @param object the object to check.
* @return the validated object (never {@code null} for method chaining).
* @throws NullPointerException if the object is {@code null}.
@@ -1050,7 +1050,7 @@ public static <T> T notNull(final T object) {
*
* <pre>Validate.notNull(myObject, "The object must not be null");</pre>
*
- * @param <T> the object type.
+ * @param <T> The object type.
* @param object the object to check.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
* @param values the optional values for the formatted exception message.
@@ -1076,7 +1076,7 @@ private static Supplier<String> toSupplier(final String
message, final Object...
* is "The validated collection index is invalid: "
* followed by the index.</p>
*
- * @param <T> the collection type.
+ * @param <T> The collection type.
* @param collection the collection to check, validated not null by this
method.
* @param index the index to check.
* @return the validated collection (never {@code null} for method
chaining).
@@ -1103,7 +1103,7 @@ public static <T extends Collection<?>> T
validIndex(final T collection, final i
* is "The validated character sequence index is invalid: "
* followed by the index.</p>
*
- * @param <T> the character sequence type.
+ * @param <T> The character sequence type.
* @param chars the character sequence to check, validated not null by
this method.
* @param index the index to check.
* @return the validated character sequence (never {@code null} for method
chaining).
@@ -1125,7 +1125,7 @@ public static <T extends CharSequence> T validIndex(final
T chars, final int ind
* <p>If the collection is {@code null}, then the message of the
* exception is "The validated object is null".</p>
*
- * @param <T> the collection type.
+ * @param <T> The collection type.
* @param collection the collection to check, validated not null by this
method.
* @param index the index to check.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
@@ -1154,7 +1154,7 @@ public static <T extends Collection<?>> T
validIndex(final T collection, final i
* <p>If the character sequence is {@code null}, then the message
* of the exception is "The validated object is null".</p>
*
- * @param <T> the character sequence type.
+ * @param <T> The character sequence type.
* @param chars the character sequence to check, validated not null by
this method.
* @param index the index to check.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
@@ -1186,7 +1186,7 @@ public static <T extends CharSequence> T validIndex(final
T chars, final int ind
* "The validated array index is invalid: " followed by the
* index.</p>
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param array the array to check, validated not null by this method.
* @param index the index to check.
* @return the validated array (never {@code null} for method chaining).
@@ -1208,7 +1208,7 @@ public static <T> T[] validIndex(final T[] array, final
int index) {
* <p>If the array is {@code null}, then the message of the exception
* is "The validated object is null".</p>
*
- * @param <T> the array type.
+ * @param <T> The array type.
* @param array the array to check, validated not null by this method.
* @param index the index to check.
* @param message the {@link String#format(String, Object...)} exception
message if invalid, not null.
diff --git
a/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
b/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
index f8a6d9567..a19d442a3 100644
--- a/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
+++ b/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
@@ -23,7 +23,7 @@
* Abstracts supplying an instance of {@code T}. Use to implement the builder
pattern.
*
* @param <T> The type of results supplied by this supplier.
- * @param <B> the type of builder.
+ * @param <B> The type of builder.
* @param <E> The kind of thrown exception or error.
* @since 3.14.0
*/
diff --git a/src/main/java/org/apache/commons/lang3/builder/Builder.java
b/src/main/java/org/apache/commons/lang3/builder/Builder.java
index 4c5a463c9..20752242f 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Builder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Builder.java
@@ -69,7 +69,7 @@
* .build();
* }</pre>
*
- * @param <T> the type of object that the builder will construct or compute.
+ * @param <T> The type of object that the builder will construct or compute.
* @since 3.0
*/
@FunctionalInterface
diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
index d24379966..5cc24f00e 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
@@ -191,7 +191,7 @@ public T getRight() {
/**
* Private interface while we still have to support serialization.
*
- * @param <T> the type of results supplied by this supplier.
+ * @param <T> The type of results supplied by this supplier.
*/
private interface SerializableSupplier<T> extends Supplier<T>,
Serializable {
// empty
diff --git a/src/main/java/org/apache/commons/lang3/builder/Diffable.java
b/src/main/java/org/apache/commons/lang3/builder/Diffable.java
index ea1ea8517..38e37968c 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Diffable.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Diffable.java
@@ -36,7 +36,7 @@
* Assert.assertEquals(expected.diff(result), expected, result);
* </pre>
*
- * @param <T> the type of objects that this object may be differentiated
against
+ * @param <T> The type of objects that this object may be differentiated
against
* @since 3.3
*/
@FunctionalInterface
diff --git
a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
index c05dc7941..a5f2f0b54 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
@@ -231,7 +231,7 @@ public static String reflectionToString(final Object
object, final ToStringStyle
* Uses {@link ReflectionToStringBuilder} to generate a
* {@code toString} for the specified object.
*
- * @param <T> the type of the object
+ * @param <T> The type of the object
* @param object the Object to be output
* @param style the style of the {@code toString} to create, may be
{@code null}
* @param outputTransients whether to include transient fields
diff --git
a/src/main/java/org/apache/commons/lang3/compare/ComparableUtils.java
b/src/main/java/org/apache/commons/lang3/compare/ComparableUtils.java
index be75a6390..8150b2423 100644
--- a/src/main/java/org/apache/commons/lang3/compare/ComparableUtils.java
+++ b/src/main/java/org/apache/commons/lang3/compare/ComparableUtils.java
@@ -34,7 +34,7 @@ public class ComparableUtils {
/**
* Compares objects of a given generic type {@code A}.
*
- * @param <A> the type of objects that this object may be compared against.
+ * @param <A> The type of objects that this object may be compared against.
*/
public static class ComparableCheckBuilder<A extends Comparable<A>> {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
index 20891c0ff..1c2150ada 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
@@ -23,7 +23,7 @@
/**
* Base class for circuit breakers.
*
- * @param <T> the type of the value monitored by this circuit breaker
+ * @param <T> The type of the value monitored by this circuit breaker
* @since 3.5
*/
public abstract class AbstractCircuitBreaker<T> implements CircuitBreaker<T> {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
index 57e4d915e..d92bb67db 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
@@ -27,7 +27,7 @@
/**
* Abstracts and defines operations for {@link ConcurrentInitializer}
implementations.
*
- * @param <T> the type of the object managed by this initializer class.
+ * @param <T> The type of the object managed by this initializer class.
* @param <E> The exception type thrown by {@link #initialize()}.
* @since 3.14.0
*/
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
index 649ea161d..1be7b77bf 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
@@ -62,7 +62,7 @@
* {@link LazyInitializer} is more appropriate.
* </p>
*
- * @param <T> the type of the object managed by this initializer class.
+ * @param <T> The type of the object managed by this initializer class.
* @since 3.0
*/
public class AtomicInitializer<T> extends AbstractConcurrentInitializer<T,
ConcurrentException> {
@@ -96,7 +96,7 @@ public I get() {
/**
* Creates a new builder.
*
- * @param <T> the type of object to build.
+ * @param <T> The type of object to build.
* @return a new builder.
* @since 3.14.0
*/
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
index 5b62c5ecd..dd989799c 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
@@ -53,7 +53,7 @@
* case.
* </p>
*
- * @param <T> the type of the object managed by this initializer class
+ * @param <T> The type of the object managed by this initializer class
* @since 3.0
*/
public class AtomicSafeInitializer<T> extends AbstractConcurrentInitializer<T,
ConcurrentException> {
@@ -87,7 +87,7 @@ public I get() {
/**
* Creates a new builder.
*
- * @param <T> the type of object to build.
+ * @param <T> The type of object to build.
* @return a new builder.
* @since 3.14.0
*/
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
index f1a02695e..b07d565d4 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
@@ -82,7 +82,7 @@
* operation is complete or to cancel the operation.
* </p>
*
- * @param <T> the type of the object managed by this initializer class
+ * @param <T> The type of the object managed by this initializer class
* @since 3.0
*/
public class BackgroundInitializer<T> extends AbstractConcurrentInitializer<T,
Exception> {
@@ -164,7 +164,7 @@ public T call() throws Exception {
/**
* Creates a new builder.
*
- * @param <T> the type of object to build.
+ * @param <T> The type of object to build.
* @return a new builder.
* @since 3.14.0
*/
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
index 77cd0765c..a5ab64006 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
@@ -61,7 +61,7 @@
* }
* </pre>
*
- * @param <T> the type of the object managed by this initializer class
+ * @param <T> The type of the object managed by this initializer class
* @since 3.0
*/
public class CallableBackgroundInitializer<T> extends BackgroundInitializer<T>
{
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
index 910d30e25..8eedc898b 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
@@ -35,7 +35,7 @@
* sufficiently generic to be applied to multiple different use cases.
* </p>
*
- * @param <T> the type of the value monitored by this circuit breaker
+ * @param <T> The type of the value monitored by this circuit breaker
* @since 3.5
*/
public interface CircuitBreaker<T> {
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/Computable.java
b/src/main/java/org/apache/commons/lang3/concurrent/Computable.java
index ac5384191..6ec1beb67 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/Computable.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/Computable.java
@@ -25,8 +25,8 @@
*
* <p>See also {@code FailableFunction<I, O, InterruptedException>}.</p>
*
- * @param <I> the type of the input to the calculation
- * @param <O> the type of the output of the calculation
+ * @param <I> The type of the input to the calculation
+ * @param <O> The type of the output of the calculation
* @see FailableFunction
* @since 3.6
*/
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentInitializer.java
index d29dca1fe..ce2d571c1 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentInitializer.java
@@ -37,7 +37,7 @@
* An implementation throws {@link ConcurrentException} if an error occurred
during initialization of the object.
* </p>
*
- * @param <T> the type of the object managed by this initializer class.
+ * @param <T> The type of the object managed by this initializer class.
* @since 3.0
*/
public interface ConcurrentInitializer<T> extends FailableSupplier<T,
ConcurrentException> {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
index 5cc2b39e9..446a4984d 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
@@ -35,7 +35,7 @@ public class ConcurrentUtils {
/**
* A specialized {@link Future} implementation which wraps a constant
value.
*
- * @param <T> the type of the value wrapped by this class
+ * @param <T> The type of the value wrapped by this class
*/
static final class ConstantFuture<T> implements Future<T> {
@@ -122,7 +122,7 @@ static Throwable checkedException(final Throwable ex) {
* A constant future can also be useful in testing.
* </p>
*
- * @param <T> the type of the value used by this {@link Future} object
+ * @param <T> The type of the value used by this {@link Future} object
* @param value the constant value to return, may be null
* @return an instance of Future that will return the value, never null
*/
@@ -141,8 +141,8 @@ public static <T> Future<T> constantFuture(final T value) {
* the map. Both the map and the initializer can be {@code null}; in this
* case this method simply returns {@code null}.
*
- * @param <K> the type of the keys of the map
- * @param <V> the type of the values of the map
+ * @param <K> The type of the keys of the map
+ * @param <V> The type of the values of the map
* @param map the map to be modified
* @param key the key of the value to be added
* @param init the {@link ConcurrentInitializer} for creating the value
@@ -169,8 +169,8 @@ public static <K, V> V createIfAbsent(final
ConcurrentMap<K, V> map, final K key
* {@code createIfAbsent()}. If a {@link ConcurrentException} is thrown, it
* is caught and re-thrown as a {@link ConcurrentRuntimeException}.
*
- * @param <K> the type of the keys of the map
- * @param <V> the type of the values of the map
+ * @param <K> The type of the keys of the map
+ * @param <V> The type of the values of the map
* @param map the map to be modified
* @param key the key of the value to be added
* @param init the {@link ConcurrentInitializer} for creating the value
@@ -280,7 +280,7 @@ public static void handleCauseUnchecked(final
ExecutionException ex) {
* {@code null}-safe: if the argument is {@code null}, result is also
* {@code null}.
*
- * @param <T> the type of the object produced by the initializer
+ * @param <T> The type of the object produced by the initializer
* @param initializer the {@link ConcurrentInitializer} to be invoked
* @return the object managed by the {@link ConcurrentInitializer}
* @throws ConcurrentException if the {@link ConcurrentInitializer} throws
@@ -299,7 +299,7 @@ public static <T> T initialize(final
ConcurrentInitializer<T> initializer)
* caught, and the cause is wrapped in a {@link
ConcurrentRuntimeException}.
* So client code does not have to deal with checked exceptions.
*
- * @param <T> the type of the object produced by the initializer
+ * @param <T> The type of the object produced by the initializer
* @param initializer the {@link ConcurrentInitializer} to be invoked
* @return the object managed by the {@link ConcurrentInitializer}
* @throws ConcurrentRuntimeException if the initializer throws an
exception
@@ -337,8 +337,8 @@ public static <T> T initializeUnchecked(final
ConcurrentInitializer<T> initializ
* {@code null}, too.
* </p>
*
- * @param <K> the type of the keys of the map
- * @param <V> the type of the values of the map
+ * @param <K> The type of the keys of the map
+ * @param <V> The type of the values of the map
* @param map the map to be modified
* @param key the key of the value to be added
* @param value the value to be added
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
index a861d4d89..15aebdb86 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
@@ -33,7 +33,7 @@
* {@link ConcurrentInitializer}.
* </p>
*
- * @param <T> the type of the object managed by this initializer
+ * @param <T> The type of the object managed by this initializer
* @since 3.0
*/
public class ConstantInitializer<T> implements ConcurrentInitializer<T> {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
index a5271eba6..75d66de63 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
@@ -66,7 +66,7 @@
* method are pretty fast because no synchronization is needed (only an access
to a <strong>volatile</strong> member field).
* </p>
*
- * @param <T> the type of the object managed by the initializer.
+ * @param <T> The type of the object managed by the initializer.
* @since 3.0
*/
public class LazyInitializer<T> extends AbstractConcurrentInitializer<T,
ConcurrentException> {
@@ -103,7 +103,7 @@ public I get() {
/**
* Creates a new builder.
*
- * @param <T> the type of object to build.
+ * @param <T> The type of object to build.
* @return a new builder.
* @since 3.14.0
*/
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/Memoizer.java
b/src/main/java/org/apache/commons/lang3/concurrent/Memoizer.java
index 8fe1c2035..d0ecf86eb 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/Memoizer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/Memoizer.java
@@ -40,8 +40,8 @@
* original implementation of the class. It was also published within Java
Concurrency in Practice as a sample.
* </p>
*
- * @param <I> the type of the input to the calculation
- * @param <O> the type of the output of the calculation
+ * @param <I> The type of the input to the calculation
+ * @param <O> The type of the output of the calculation
* @since 3.6
*/
public class Memoizer<I, O> implements Computable<I, O> {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
b/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
index ddbdf6bc5..3f6f77b16 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
@@ -138,8 +138,8 @@ public class LockingVisitors {
/**
* Wraps a domain object and a lock for access by lambdas.
*
- * @param <O> the wrapped object type.
- * @param <L> the wrapped lock type.
+ * @param <O> The wrapped object type.
+ * @param <L> The wrapped lock type.
* @see LockingVisitors
*/
public static class LockVisitor<O, L> {
@@ -147,9 +147,9 @@ public static class LockVisitor<O, L> {
/**
* Builds {@link LockVisitor} instances.
*
- * @param <O> the wrapped object type.
- * @param <L> the wrapped lock type.
- * @param <B> the builder type.
+ * @param <O> The wrapped object type.
+ * @param <L> The wrapped lock type.
+ * @param <B> The builder type.
* @since 3.18.0
*/
public static class LVBuilder<O, L, B extends LVBuilder<O, L, B>>
extends AbstractSupplier<LockVisitor<O, L>, B, RuntimeException> {
@@ -477,7 +477,7 @@ public static class ReadWriteLockVisitor<O> extends
LockVisitor<O, ReadWriteLock
/**
* Builds {@link LockVisitor} instances.
*
- * @param <O> the wrapped object type.
+ * @param <O> The wrapped object type.
* @since 3.18.0
*/
public static class Builder<O> extends LVBuilder<O, ReadWriteLock,
Builder<O>> {
@@ -505,7 +505,7 @@ public Builder<O> setLock(final ReadWriteLock
readWriteLock) {
/**
* Creates a new builder.
*
- * @param <O> the wrapped object type.
+ * @param <O> The wrapped object type.
* @return a new builder.
* @since 3.18.0
*/
@@ -549,7 +549,7 @@ public static class ReentrantLockVisitor<O> extends
LockVisitor<O, ReentrantLock
/**
* Builds {@link LockVisitor} instances.
*
- * @param <O> the wrapped object type.
+ * @param <O> The wrapped object type.
* @since 3.18.0
*/
public static class Builder<O> extends LVBuilder<O, ReentrantLock,
Builder<O>> {
@@ -578,7 +578,7 @@ public Builder<O> setLock(final ReentrantLock
reentrantLock) {
/**
* Creates a new builder.
*
- * @param <O> the wrapped object type.
+ * @param <O> The wrapped object type.
* @return a new builder.
* @since 3.18.0
*/
@@ -624,7 +624,7 @@ public static class StampedLockVisitor<O> extends
LockVisitor<O, StampedLock> {
/**
* Builds {@link LockVisitor} instances.
*
- * @param <O> the wrapped object type.
+ * @param <O> The wrapped object type.
* @since 3.18.0
*/
public static class Builder<O> extends LVBuilder<O, StampedLock,
Builder<O>> {
@@ -653,7 +653,7 @@ public Builder<O> setLock(final StampedLock stampedLock) {
/**
* Creates a new builder.
*
- * @param <O> the wrapped object type.
+ * @param <O> The wrapped object type.
* @return a new builder.
* @since 3.18.0
*/
diff --git
a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
index f3639b25c..a4e69b367 100644
--- a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
+++ b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
@@ -62,7 +62,7 @@
* Serializing an {@link EventListenerSupport} instance will result in any
non-{@link Serializable} listeners being silently dropped.
* </p>
*
- * @param <L> the type of event listener that is supported by this proxy.
+ * @param <L> The type of event listener that is supported by this proxy.
* @since 3.0
*/
public class EventListenerSupport<L> implements Serializable {
@@ -139,7 +139,7 @@ public Object invoke(final Object unusedProxy, final Method
method, final Object
* Creates an EventListenerSupport object which supports the specified
* listener type.
*
- * @param <T> the type of the listener interface
+ * @param <T> The type of the listener interface
* @param listenerInterface the type of listener interface that will
receive
* events posted using this class.
*
diff --git
a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
index 405b57e90..1ea737f24 100644
--- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
+++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
@@ -900,7 +900,7 @@ public static Stream<Throwable> stream(final Throwable
throwable) {
/**
* Worker method for the {@code throwableOfType} methods.
*
- * @param <T> the type of Throwable you are searching.
+ * @param <T> The type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null.
* @param type the type to search, subclasses match, null returns null.
* @param fromIndex the (zero-based) index of the starting position,
@@ -946,7 +946,7 @@ private static <T extends Throwable> T throwableOf(final
Throwable throwable, fi
* A {@code null} type returns {@code null}.
* No match in the chain returns {@code null}.</p>
*
- * @param <T> the type of Throwable you are searching.
+ * @param <T> The type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null.
* @param clazz the class to search for, subclasses do not match, null
returns null.
* @return the first matching throwable from the throwable chain, null if
no match or null input.
@@ -986,7 +986,7 @@ public static <T extends Throwable> T
throwableOfThrowable(final Throwable throw
* A {@code null} type returns {@code null}.
* No match in the chain returns {@code null}.</p>
*
- * @param <T> the type of Throwable you are searching.
+ * @param <T> The type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null.
* @param type the type to search for, subclasses match, null returns
null.
* @return the first matching throwable from the throwable chain, null if
no match or null input.
diff --git a/src/main/java/org/apache/commons/lang3/function/Failable.java
b/src/main/java/org/apache/commons/lang3/function/Failable.java
index cd906cc64..f0b710d98 100644
--- a/src/main/java/org/apache/commons/lang3/function/Failable.java
+++ b/src/main/java/org/apache/commons/lang3/function/Failable.java
@@ -78,9 +78,9 @@ public class Failable {
* @param consumer the consumer to accept, may be null for a noop.
* @param object1 the first object to consume by {@code consumer}
* @param object2 the second object to consume by {@code consumer}
- * @param <T> the type of the first argument the consumer accepts
- * @param <U> the type of the second argument the consumer accepts
- * @param <E> the type of checked exception the consumer may throw
+ * @param <T> The type of the first argument the consumer accepts
+ * @param <U> The type of the second argument the consumer accepts
+ * @param <E> The type of checked exception the consumer may throw
*/
public static <T, U, E extends Throwable> void accept(final
FailableBiConsumer<T, U, E> consumer, final T object1,
final U object2) {
@@ -92,8 +92,8 @@ public static <T, U, E extends Throwable> void accept(final
FailableBiConsumer<T
*
* @param consumer the consumer to accept, may be null for a noop.
* @param object the object to consume by {@code consumer}
- * @param <T> the type the consumer accepts
- * @param <E> the type of checked exception the consumer may throw
+ * @param <T> The type the consumer accepts
+ * @param <E> The type of checked exception the consumer may throw
*/
public static <T, E extends Throwable> void accept(final
FailableConsumer<T, E> consumer, final T object) {
run(consumer, () -> consumer.accept(object));
@@ -104,7 +104,7 @@ public static <T, E extends Throwable> void accept(final
FailableConsumer<T, E>
*
* @param consumer the consumer to accept, may be null for a noop.
* @param value the value to consume by {@code consumer}
- * @param <E> the type of checked exception the consumer may throw
+ * @param <E> The type of checked exception the consumer may throw
*/
public static <E extends Throwable> void accept(final
FailableDoubleConsumer<E> consumer, final double value) {
run(consumer, () -> consumer.accept(value));
@@ -115,7 +115,7 @@ public static <E extends Throwable> void accept(final
FailableDoubleConsumer<E>
*
* @param consumer the consumer to accept, may be null for a noop.
* @param value the value to consume by {@code consumer}
- * @param <E> the type of checked exception the consumer may throw
+ * @param <E> The type of checked exception the consumer may throw
*/
public static <E extends Throwable> void accept(final
FailableIntConsumer<E> consumer, final int value) {
run(consumer, () -> consumer.accept(value));
@@ -126,7 +126,7 @@ public static <E extends Throwable> void accept(final
FailableIntConsumer<E> con
*
* @param consumer the consumer to accept, may be null for a noop.
* @param value the value to consume by {@code consumer}
- * @param <E> the type of checked exception the consumer may throw
+ * @param <E> The type of checked exception the consumer may throw
*/
public static <E extends Throwable> void accept(final
FailableLongConsumer<E> consumer, final long value) {
run(consumer, () -> consumer.accept(value));
@@ -138,10 +138,10 @@ public static <E extends Throwable> void accept(final
FailableLongConsumer<E> co
* @param function the function to apply
* @param input1 the first input to apply {@code function} on
* @param input2 the second input to apply {@code function} on
- * @param <T> the type of the first argument the function accepts
- * @param <U> the type of the second argument the function accepts
- * @param <R> the return type of the function
- * @param <E> the type of checked exception the function may throw
+ * @param <T> The type of the first argument the function accepts
+ * @param <U> The type of the second argument the function accepts
+ * @param <R> The return type of the function
+ * @param <E> The type of checked exception the function may throw
* @return the value returned from the function
*/
public static <T, U, R, E extends Throwable> R apply(final
FailableBiFunction<T, U, R, E> function, final T input1,
@@ -154,9 +154,9 @@ public static <T, U, R, E extends Throwable> R apply(final
FailableBiFunction<T,
*
* @param function the function to apply
* @param input the input to apply {@code function} on
- * @param <T> the type of the argument the function accepts
- * @param <R> the return type of the function
- * @param <E> the type of checked exception the function may throw
+ * @param <T> The type of the argument the function accepts
+ * @param <R> The return type of the function
+ * @param <E> The type of checked exception the function may throw
* @return the value returned from the function
*/
public static <T, R, E extends Throwable> R apply(final
FailableFunction<T, R, E> function, final T input) {
@@ -169,7 +169,7 @@ public static <T, R, E extends Throwable> R apply(final
FailableFunction<T, R, E
* @param function the function to apply
* @param left the first input to apply {@code function} on
* @param right the second input to apply {@code function} on
- * @param <E> the type of checked exception the function may throw
+ * @param <E> The type of checked exception the function may throw
* @return the value returned from the function
*/
public static <E extends Throwable> double applyAsDouble(final
FailableDoubleBinaryOperator<E> function,
@@ -285,8 +285,8 @@ public static <T, U, V, R, E1 extends Throwable, E2 extends
Throwable, E3 extend
/**
* Converts the given {@link FailableBiConsumer} into a standard {@link
BiConsumer}.
*
- * @param <T> the type of the first argument of the consumers
- * @param <U> the type of the second argument of the consumers
+ * @param <T> The type of the first argument of the consumers
+ * @param <U> The type of the second argument of the consumers
* @param consumer a failable {@link BiConsumer}
* @return a standard {@link BiConsumer}
*/
@@ -297,9 +297,9 @@ public static <T, U> BiConsumer<T, U> asBiConsumer(final
FailableBiConsumer<T, U
/**
* Converts the given {@link FailableBiFunction} into a standard {@link
BiFunction}.
*
- * @param <T> the type of the first argument of the input of the functions
- * @param <U> the type of the second argument of the input of the functions
- * @param <R> the type of the output of the functions
+ * @param <T> The type of the first argument of the input of the functions
+ * @param <U> The type of the second argument of the input of the functions
+ * @param <R> The type of the output of the functions
* @param function a {@link FailableBiFunction}
* @return a standard {@link BiFunction}
*/
@@ -310,8 +310,8 @@ public static <T, U, R> BiFunction<T, U, R>
asBiFunction(final FailableBiFunctio
/**
* Converts the given {@link FailableBiPredicate} into a standard {@link
BiPredicate}.
*
- * @param <T> the type of the first argument used by the predicates
- * @param <U> the type of the second argument used by the predicates
+ * @param <T> The type of the first argument used by the predicates
+ * @param <U> The type of the second argument used by the predicates
* @param predicate a {@link FailableBiPredicate}
* @return a standard {@link BiPredicate}
*/
@@ -322,7 +322,7 @@ public static <T, U> BiPredicate<T, U> asBiPredicate(final
FailableBiPredicate<T
/**
* Converts the given {@link FailableCallable} into a standard {@link
Callable}.
*
- * @param <V> the type used by the callables
+ * @param <V> The type used by the callables
* @param callable a {@link FailableCallable}
* @return a standard {@link Callable}
*/
@@ -333,7 +333,7 @@ public static <V> Callable<V> asCallable(final
FailableCallable<V, ?> callable)
/**
* Converts the given {@link FailableConsumer} into a standard {@link
Consumer}.
*
- * @param <T> the type used by the consumers
+ * @param <T> The type used by the consumers
* @param consumer a {@link FailableConsumer}
* @return a standard {@link Consumer}
*/
@@ -344,8 +344,8 @@ public static <T> Consumer<T> asConsumer(final
FailableConsumer<T, ?> consumer)
/**
* Converts the given {@link FailableFunction} into a standard {@link
Function}.
*
- * @param <T> the type of the input of the functions
- * @param <R> the type of the output of the functions
+ * @param <T> The type of the input of the functions
+ * @param <R> The type of the output of the functions
* @param function a {code FailableFunction}
* @return a standard {@link Function}
*/
@@ -356,7 +356,7 @@ public static <T, R> Function<T, R> asFunction(final
FailableFunction<T, R, ?> f
/**
* Converts the given {@link FailablePredicate} into a standard {@link
Predicate}.
*
- * @param <T> the type used by the predicates
+ * @param <T> The type used by the predicates
* @param predicate a {@link FailablePredicate}
* @return a standard {@link Predicate}
*/
@@ -377,7 +377,7 @@ public static Runnable asRunnable(final FailableRunnable<?>
runnable) {
/**
* Converts the given {@link FailableSupplier} into a standard {@link
Supplier}.
*
- * @param <T> the type supplied by the suppliers
+ * @param <T> The type supplied by the suppliers
* @param supplier a {@link FailableSupplier}
* @return a standard {@link Supplier}
*/
@@ -389,8 +389,8 @@ public static <T> Supplier<T> asSupplier(final
FailableSupplier<T, ?> supplier)
* Calls a callable and rethrows any exception as a {@link
RuntimeException}.
*
* @param callable the callable to call
- * @param <V> the return type of the callable
- * @param <E> the type of checked exception the callable may throw
+ * @param <V> The return type of the callable
+ * @param <E> The type of checked exception the callable may throw
* @return the value returned from the callable
*/
public static <V, E extends Throwable> V call(final FailableCallable<V, E>
callable) {
@@ -526,7 +526,7 @@ public static RuntimeException rethrow(final Throwable
throwable) {
* Runs a runnable and rethrows any exception as a {@link
RuntimeException}.
*
* @param runnable The runnable to run, may be null for a noop.
- * @param <E> the type of checked exception the runnable may throw.
+ * @param <E> The type of checked exception the runnable may throw.
*/
public static <E extends Throwable> void run(final FailableRunnable<E>
runnable) {
if (runnable != null) {
@@ -584,9 +584,9 @@ public static <T> FailableStream<T> stream(final Stream<T>
stream) {
* @param predicate the predicate to test
* @param object1 the first input to test by {@code predicate}
* @param object2 the second input to test by {@code predicate}
- * @param <T> the type of the first argument the predicate tests
- * @param <U> the type of the second argument the predicate tests
- * @param <E> the type of checked exception the predicate may throw
+ * @param <T> The type of the first argument the predicate tests
+ * @param <U> The type of the second argument the predicate tests
+ * @param <E> The type of checked exception the predicate may throw
* @return the boolean value returned by the predicate
*/
public static <T, U, E extends Throwable> boolean test(final
FailableBiPredicate<T, U, E> predicate,
@@ -599,8 +599,8 @@ public static <T, U, E extends Throwable> boolean
test(final FailableBiPredicate
*
* @param predicate the predicate to test
* @param object the input to test by {@code predicate}
- * @param <T> the type of argument the predicate tests
- * @param <E> the type of checked exception the predicate may throw
+ * @param <T> The type of argument the predicate tests
+ * @param <E> The type of checked exception the predicate may throw
* @return the boolean value returned by the predicate
*/
public static <T, E extends Throwable> boolean test(final
FailablePredicate<T, E> predicate, final T object) {
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 d0911b3aa..dd23d60be 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java
@@ -54,7 +54,7 @@ static <T, U, R, E extends Throwable> FailableBiFunction<T,
U, R, E> nop() {
/**
* Returns a composed {@link FailableBiFunction} that like {@link
BiFunction#andThen(Function)}.
*
- * @param <V> the output type of the {@code after} function, and of the
composed function.
+ * @param <V> The output type of the {@code after} function, and of the
composed function.
* @param after the operation to perform after this one.
* @return a composed {@link FailableBiFunction} that like {@link
BiFunction#andThen(Function)}.
* @throws NullPointerException when {@code after} is null.
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 6a9df5f64..d87ade4d2 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java
@@ -28,7 +28,7 @@
* This is a functional interface whose functional method is {@link
#accept(Object)}.
* </p>
*
- * @param <T> the type of the argument the consumer accepts.
+ * @param <T> The type of the argument the consumer accepts.
* @param <E> The thrown exception type.
* @since 3.11
*/
@@ -58,7 +58,7 @@ static <T, E extends Throwable> void accept(final
FailableConsumer<T, E> consume
/**
* Gets the NOP singleton.
*
- * @param <T> the type of the argument the consumer accepts.
+ * @param <T> The type of the argument the consumer accepts.
* @param <E> The thrown exception type.
* @return The NOP singleton.
*/
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 dfb101e23..c9252b91a 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableFunction.java
@@ -52,7 +52,7 @@ static <T, R, E extends Throwable> FailableFunction<T, R, E>
function(final Fail
/**
* Returns a function that always returns its input argument.
*
- * @param <T> the type of the input and output objects to the function
+ * @param <T> The type of the input and output objects to the function
* @param <E> The type of thrown exception or error.
* @return a function that always returns its input argument
*/
@@ -76,7 +76,7 @@ static <T, R, E extends Throwable> FailableFunction<T, R, E>
nop() {
/**
* Returns a composed {@link FailableFunction} like {@link
Function#andThen(Function)}.
*
- * @param <V> the output type of the {@code after} function, and of the
composed function.
+ * @param <V> The output type of the {@code after} function, and of the
composed function.
* @return a composed {@link FailableFunction} like {@link
Function#andThen(Function)}.
* @param after the operation to perform after this one.
* @throws NullPointerException when {@code after} is null.
@@ -98,7 +98,7 @@ default <V> FailableFunction<T, V, E> andThen(final
FailableFunction<? super R,
/**
* Returns a composed {@link FailableFunction} like {@link
Function#compose(Function)}.
*
- * @param <V> the input type to the {@code before} function, and to the
composed function.
+ * @param <V> The input type to the {@code before} function, and to the
composed function.
* @param before the operator to apply before this one.
* @return a composed {@link FailableFunction} like {@link
Function#compose(Function)}.
* @throws NullPointerException if before is null.
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 e22ccc471..bfb82b51b 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableObjDoubleConsumer.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableObjDoubleConsumer.java
@@ -22,7 +22,7 @@
/**
* A functional interface like {@link ObjDoubleConsumer} that declares a
{@link Throwable}.
*
- * @param <T> the type of the object argument to the operation.
+ * @param <T> The type of the object argument to the operation.
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -36,7 +36,7 @@ public interface FailableObjDoubleConsumer<T, E extends
Throwable> {
/**
* Gets the NOP singleton.
*
- * @param <T> the type of the object argument to the operation.
+ * @param <T> The type of the object argument to the operation.
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
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 5ecd3e703..1e95091d9 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableObjIntConsumer.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableObjIntConsumer.java
@@ -22,7 +22,7 @@
/**
* A functional interface like {@link ObjIntConsumer} that declares a {@link
Throwable}.
*
- * @param <T> the type of the object argument to the operation.
+ * @param <T> The type of the object argument to the operation.
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -36,7 +36,7 @@ public interface FailableObjIntConsumer<T, E extends
Throwable> {
/**
* Gets the NOP singleton.
*
- * @param <T> the type of the object argument to the operation.
+ * @param <T> The type of the object argument to the operation.
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
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 bc635ee3d..d8540e343 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableObjLongConsumer.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableObjLongConsumer.java
@@ -22,7 +22,7 @@
/**
* A functional interface like {@link ObjLongConsumer} that declares a {@link
Throwable}.
*
- * @param <T> the type of the object argument to the operation.
+ * @param <T> The type of the object argument to the operation.
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -36,7 +36,7 @@ public interface FailableObjLongConsumer<T, E extends
Throwable> {
/**
* Gets the NOP singleton.
*
- * @param <T> the type of the object argument to the operation.
+ * @param <T> The type of the object argument to the operation.
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
diff --git
a/src/main/java/org/apache/commons/lang3/function/FailableToBooleanFunction.java
b/src/main/java/org/apache/commons/lang3/function/FailableToBooleanFunction.java
index f5d53828c..6f6d49b72 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableToBooleanFunction.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableToBooleanFunction.java
@@ -20,7 +20,7 @@
/**
* A functional interface like a {@code ToBooleanFunction} that declares a
{@link Throwable}.
*
- * @param <T> the type of the argument to the function
+ * @param <T> The type of the argument to the function
* @param <E> The kind of thrown exception or error.
* @since 3.18
*/
@@ -34,7 +34,7 @@ public interface FailableToBooleanFunction<T, E extends
Throwable> {
/**
* Gets the NOP singleton.
*
- * @param <T> the type of the argument to the function
+ * @param <T> The type of the argument to the function
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
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 3581dce82..f2ea2ce8e 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java
@@ -22,8 +22,8 @@
/**
* A functional interface like {@link ToDoubleBiFunction} that declares a
{@link Throwable}.
*
- * @param <T> the type of the first argument to the function
- * @param <U> the type of the second argument to the function
+ * @param <T> The type of the first argument to the function
+ * @param <U> The type of the second argument to the function
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -37,8 +37,8 @@ public interface FailableToDoubleBiFunction<T, U, E extends
Throwable> {
/**
* Gets 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
+ * @param <T> The type of the first argument to the function
+ * @param <U> The type of the second argument to the function
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
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 b31401295..fafc88c0e 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java
@@ -22,7 +22,7 @@
/**
* A functional interface like {@link ToDoubleFunction} that declares a {@link
Throwable}.
*
- * @param <T> the type of the argument to the function
+ * @param <T> The type of the argument to the function
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -36,7 +36,7 @@ public interface FailableToDoubleFunction<T, E extends
Throwable> {
/**
* Gets the NOP singleton.
*
- * @param <T> the type of the argument to the function
+ * @param <T> The type of the argument to the function
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
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 15a624e5d..77f3ea3ac 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java
@@ -22,8 +22,8 @@
/**
* A functional interface like {@link ToIntBiFunction} that declares a {@link
Throwable}.
*
- * @param <T> the type of the first argument to the function
- * @param <U> the type of the second argument to the function
+ * @param <T> The type of the first argument to the function
+ * @param <U> The type of the second argument to the function
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -37,8 +37,8 @@ public interface FailableToIntBiFunction<T, U, E extends
Throwable> {
/**
* Gets 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
+ * @param <T> The type of the first argument to the function
+ * @param <U> The type of the second argument to the function
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
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 6426cd9d9..ec17296e9 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java
@@ -22,7 +22,7 @@
/**
* A functional interface like {@link ToIntFunction} that declares a {@link
Throwable}.
*
- * @param <T> the type of the argument to the function
+ * @param <T> The type of the argument to the function
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -36,7 +36,7 @@ public interface FailableToIntFunction<T, E extends
Throwable> {
/**
* Gets the NOP singleton.
*
- * @param <T> the type of the argument to the function
+ * @param <T> The type of the argument to the function
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
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 ab79c60bf..1d36998bd 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java
@@ -22,8 +22,8 @@
/**
* A functional interface like {@link ToLongBiFunction} that declares a {@link
Throwable}.
*
- * @param <T> the type of the first argument to the function
- * @param <U> the type of the second argument to the function
+ * @param <T> The type of the first argument to the function
+ * @param <U> The type of the second argument to the function
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -37,8 +37,8 @@ public interface FailableToLongBiFunction<T, U, E extends
Throwable> {
/**
* Gets 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
+ * @param <T> The type of the first argument to the function
+ * @param <U> The type of the second argument to the function
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
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 605ff3306..a19a64ac8 100644
---
a/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java
+++
b/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java
@@ -22,7 +22,7 @@
/**
* A functional interface like {@link ToLongFunction} that declares a {@link
Throwable}.
*
- * @param <T> the type of the first argument to the function
+ * @param <T> The type of the first argument to the function
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
@@ -36,7 +36,7 @@ public interface FailableToLongFunction<T, E extends
Throwable> {
/**
* Gets the NOP singleton.
*
- * @param <T> the type of the argument to the function
+ * @param <T> The type of the argument to the function
* @param <E> The kind of thrown exception or error.
* @return The NOP singleton.
*/
diff --git
a/src/main/java/org/apache/commons/lang3/function/MethodInvokers.java
b/src/main/java/org/apache/commons/lang3/function/MethodInvokers.java
index c0ed5dd0f..0ba592b7a 100644
--- a/src/main/java/org/apache/commons/lang3/function/MethodInvokers.java
+++ b/src/main/java/org/apache/commons/lang3/function/MethodInvokers.java
@@ -75,8 +75,8 @@ public final class MethodInvokers {
* to a fluent setter). You call the BiConsumer with two arguments: (1)
the object receiving the method call, and (2)
* the method argument.
*
- * @param <T> the type of the first argument to the operation: The type
containing the Method.
- * @param <U> the type of the second argument to the operation: The type
of the method argument.
+ * @param <T> The type of the first argument to the operation: The type
containing the Method.
+ * @param <U> The type of the second argument to the operation: The type
of the method argument.
* @param method the method to invoke.
* @return a correctly-typed wrapper for the given target.
*/
@@ -99,9 +99,9 @@ public static <T, U> BiConsumer<T, U> asBiConsumer(final
Method method) {
* assertEquals('C', function.apply("ABC", 2));
* }</pre>
*
- * @param <T> the type of the first argument to the function: The type
containing the method.
- * @param <U> the type of the second argument to the function: the method
argument type.
- * @param <R> the type of the result of the function: The method return
type.
+ * @param <T> The type of the first argument to the function: The type
containing the method.
+ * @param <U> The type of the second argument to the function: the method
argument type.
+ * @param <R> The type of the result of the function: The method return
type.
* @param method the method to invoke.
* @return a correctly-typed wrapper for the given target.
*/
@@ -115,8 +115,8 @@ public static <T, U, R> BiFunction<T, U, R>
asBiFunction(final Method method) {
* opposed to a fluent setter). You call the FailableBiConsumer with two
arguments: (1) the object receiving the method
* call, and (2) the method argument.
*
- * @param <T> the type of the first argument to the operation: The type
containing the Method.
- * @param <U> the type of the second argument to the operation: The type
of the method argument.
+ * @param <T> The type of the first argument to the operation: The type
containing the Method.
+ * @param <U> The type of the second argument to the operation: The type
of the method argument.
* @param method the method to invoke.
* @return a correctly-typed wrapper for the given target.
*/
@@ -130,9 +130,9 @@ public static <T, U> FailableBiConsumer<T, U, Throwable>
asFailableBiConsumer(fi
* two arguments: (1) the object receiving the method call, and (2) the
method argument. The BiFunction return type must
* match the method's return type.
*
- * @param <T> the type of the first argument to the function: The type
containing the method.
- * @param <U> the type of the second argument to the function: the method
argument type.
- * @param <R> the type of the result of the function: The method return
type.
+ * @param <T> The type of the first argument to the function: The type
containing the method.
+ * @param <U> The type of the second argument to the function: the method
argument type.
+ * @param <R> The type of the result of the function: The method return
type.
* @param method the method to invoke.
* @return a correctly-typed wrapper for the given target.
*/
@@ -145,8 +145,8 @@ public static <T, U, R> FailableBiFunction<T, U, R,
Throwable> asFailableBiFunct
* Produces a {@link FailableFunction} for a given a <em>supplier</em>
Method. You call the Function with one argument:
* the object receiving the method call. The FailableFunction return type
must match the method's return type.
*
- * @param <T> the type of the first argument to the function: The type
containing the method.
- * @param <R> the type of the result of the function: The method return
type.
+ * @param <T> The type of the first argument to the function: The type
containing the method.
+ * @param <R> The type of the result of the function: The method return
type.
* @param method the method to invoke.
* @return a correctly-typed wrapper for the given target.
*/
@@ -184,8 +184,8 @@ public static <R> FailableSupplier<R, Throwable>
asFailableSupplier(final Method
* assertEquals(3, function.apply("ABC"));
* }</pre>
*
- * @param <T> the type of the first argument to the function: The type
containing the method.
- * @param <R> the type of the result of the function: The method return
type.
+ * @param <T> The type of the first argument to the function: The type
containing the method.
+ * @param <R> The type of the result of the function: The method return
type.
* @param method the method to invoke.
* @return a correctly-typed wrapper for the given target.
*/
diff --git a/src/main/java/org/apache/commons/lang3/function/Predicates.java
b/src/main/java/org/apache/commons/lang3/function/Predicates.java
index 7039fb822..6e6659822 100644
--- a/src/main/java/org/apache/commons/lang3/function/Predicates.java
+++ b/src/main/java/org/apache/commons/lang3/function/Predicates.java
@@ -32,7 +32,7 @@ public class Predicates {
/**
* Gets the Predicate singleton that always returns false.
*
- * @param <T> the type of the input to the predicate.
+ * @param <T> The type of the input to the predicate.
* @return the Predicate singleton.
*/
@SuppressWarnings("unchecked")
@@ -44,7 +44,7 @@ public static <T> Predicate<T> falsePredicate() {
/**
* Gets the Predicate singleton that always returns true.
*
- * @param <T> the type of the input to the predicate.
+ * @param <T> The type of the input to the predicate.
* @return the Predicate singleton.
*/
@SuppressWarnings("unchecked")
diff --git a/src/main/java/org/apache/commons/lang3/function/Suppliers.java
b/src/main/java/org/apache/commons/lang3/function/Suppliers.java
index 2c4fb0ffe..b3a0e32fb 100644
--- a/src/main/java/org/apache/commons/lang3/function/Suppliers.java
+++ b/src/main/java/org/apache/commons/lang3/function/Suppliers.java
@@ -38,7 +38,7 @@ public class Suppliers {
/**
* Null-safe call to {@link Supplier#get()}.
*
- * @param <T> the type of results supplied by this supplier.
+ * @param <T> The type of results supplied by this supplier.
* @param supplier the supplier or null.
* @return Result of {@link Supplier#get()} or null.
*/
diff --git
a/src/main/java/org/apache/commons/lang3/function/ToBooleanBiFunction.java
b/src/main/java/org/apache/commons/lang3/function/ToBooleanBiFunction.java
index 438e36e92..601687ee3 100644
--- a/src/main/java/org/apache/commons/lang3/function/ToBooleanBiFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/ToBooleanBiFunction.java
@@ -23,8 +23,8 @@
* A function that accepts two arguments and produces a boolean result. This
is the {@code boolean}-producing primitive
* specialization for {@link BiFunction}.
*
- * @param <T> the type of the first argument to the function.
- * @param <U> the type of the second argument to the function.
+ * @param <T> The type of the first argument to the function.
+ * @param <U> The type of the second argument to the function.
* @see BiFunction
* @since 3.12.0
*/
diff --git a/src/main/java/org/apache/commons/lang3/function/TriFunction.java
b/src/main/java/org/apache/commons/lang3/function/TriFunction.java
index 38310cf2b..89541eda8 100644
--- a/src/main/java/org/apache/commons/lang3/function/TriFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/TriFunction.java
@@ -28,10 +28,10 @@
* {@link #apply(Object, Object, Object)}.
* </p>
*
- * @param <T> the type of the first argument to the function
- * @param <U> the type of the second argument to the function
- * @param <V> the type of the third argument to the function
- * @param <R> the type of the result of the function
+ * @param <T> The type of the first argument to the function
+ * @param <U> The type of the second argument to the function
+ * @param <V> The type of the third argument to the function
+ * @param <R> The type of the result of the function
* @see Function
* @since 3.12.0
*/
@@ -43,7 +43,7 @@ public interface TriFunction<T, U, V, R> {
* function to the result. If evaluation of either function throws an
exception, it is relayed to the caller of the
* composed function.
*
- * @param <W> the type of output of the {@code after} function, and of the
composed function
+ * @param <W> 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
* @throws NullPointerException if after is null
diff --git a/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
b/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
index 71254a5a1..7f88e7d8e 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
@@ -30,7 +30,7 @@
* Integer/Long wrapper objects.
* </p>
*
- * @param <T> the type to wrap.
+ * @param <T> The type to wrap.
* @since 2.1
*/
public interface Mutable<T> extends Supplier<T> {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
index 19f2be998..f6379e2b3 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
@@ -27,7 +27,7 @@
* This class was created before the introduction of the {@link
java.util.concurrent.atomic} package and the {@link AtomicReference} class.
* </p>
*
- * @param <T> the type to set and get.
+ * @param <T> The type to set and get.
* @see AtomicReference
* @since 2.1
*/
diff --git a/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java
b/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java
index 7f6f3090d..a7059ba16 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java
@@ -70,7 +70,7 @@
* <T> T obtain(Typed<T> typed, ...);
* }</pre>
*
- * @param <T> the type
+ * @param <T> The type
* @since 3.2
*/
public abstract class TypeLiteral<T> implements Typed<T> {
diff --git a/src/main/java/org/apache/commons/lang3/reflect/Typed.java
b/src/main/java/org/apache/commons/lang3/reflect/Typed.java
index 9f73ff53c..b28d90748 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/Typed.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/Typed.java
@@ -21,7 +21,7 @@
/**
* Generalization of "has a type."
*
- * @param <T> the type
+ * @param <T> The type
* @see TypeLiteral
* @since 3.2
*/
diff --git a/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java
b/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java
index ad7e115ae..17dd345ec 100644
--- a/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java
+++ b/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java
@@ -45,8 +45,8 @@ public final class LangCollectors {
/**
* Simple implementation class for {@code Collector}.
*
- * @param <T> the type of elements to be collected
- * @param <R> the type of the result
+ * @param <T> The type of elements to be collected
+ * @param <R> The type of the result
*/
private static final class SimpleCollector<T, A, R> implements
Collector<T, A, R> {
diff --git a/src/main/java/org/apache/commons/lang3/stream/Streams.java
b/src/main/java/org/apache/commons/lang3/stream/Streams.java
index 1be9b6f8d..a1f9b6285 100644
--- a/src/main/java/org/apache/commons/lang3/stream/Streams.java
+++ b/src/main/java/org/apache/commons/lang3/stream/Streams.java
@@ -286,8 +286,8 @@ protected void assertNotTerminated() {
* }
* </pre>
*
- * @param <R> the type of the result
- * @param <A> the intermediate accumulation type of the {@link
Collector}
+ * @param <R> The type of the result
+ * @param <A> The intermediate accumulation type of the {@link
Collector}
* @param collector the {@link Collector} describing the reduction
* @return the result of the reduction
* @see #collect(Supplier, BiConsumer, BiConsumer)
@@ -569,7 +569,7 @@ public static <T> FailableStream<T> failableStream(final
Stream<T> stream) {
/**
* Shorthand for {@code Streams.failableStream(value == null ?
Stream.empty() : Stream.of(value))}.
*
- * @param <T> the type of stream elements.
+ * @param <T> The type of stream elements.
* @param value the single element of the new stream, may be {@code null}.
* @return the new FailableStream on {@code value} or an empty stream.
* @since 3.15.0
@@ -581,7 +581,7 @@ public static <T> FailableStream<T> failableStream(final T
value) {
/**
* Shorthand for {@code Streams.failableStream(Streams.of(arrayValues))}.
*
- * @param <T> the type of stream elements.
+ * @param <T> The type of stream elements.
* @param values the elements of the new stream, may be {@code null}.
* @return the new FailableStream on {@code values} or an empty stream.
* @since 3.14.0
@@ -600,7 +600,7 @@ public static <T> FailableStream<T> failableStream(final
T... values) {
* {@code (Stream<E>) Streams.toStream(collection).filter(collection,
SomeClass.class::isInstance);}
* </pre>
*
- * @param <E> the type of elements in the collection we want to stream.
+ * @param <E> The type of elements in the collection we want to stream.
* @param clazz the type of elements in the collection we want to stream.
* @param collection the collection to stream or null.
* @return A non-null stream that only provides instances we want.
@@ -618,7 +618,7 @@ private static <E> Stream<E> instancesOf(final Class<?
super E> clazz, final Str
/**
* Streams the non-null elements of a collection.
*
- * @param <E> the type of elements in the collection.
+ * @param <E> The type of elements in the collection.
* @param collection the collection to stream or null.
* @return A non-null stream that filters out null elements.
* @since 3.13.0
@@ -630,7 +630,7 @@ public static <E> Stream<E> nonNull(final Collection<E>
collection) {
/**
* Streams the non-null element.
*
- * @param <E> the type of elements in the collection.
+ * @param <E> The type of elements in the collection.
* @param array the element to stream or null.
* @return A non-null stream that filters out a null element.
* @since 3.15.0
@@ -642,7 +642,7 @@ public static <E> Stream<E> nonNull(final E array) {
/**
* Streams the non-null elements of an array.
*
- * @param <E> the type of elements in the collection.
+ * @param <E> The type of elements in the collection.
* @param array the array to stream or null.
* @return A non-null stream that filters out null elements.
* @since 3.13.0
@@ -655,7 +655,7 @@ public static <E> Stream<E> nonNull(final E... array) {
/**
* Streams the non-null elements of a stream.
*
- * @param <E> the type of elements in the collection.
+ * @param <E> The type of elements in the collection.
* @param stream the stream to stream or null.
* @return A non-null stream that filters out null elements.
* @since 3.13.0
@@ -667,7 +667,7 @@ public static <E> Stream<E> nonNull(final Stream<E> stream)
{
/**
* Delegates to {@link Collection#stream()} or returns {@link
Stream#empty()} if the collection is null.
*
- * @param <E> the type of elements in the collection.
+ * @param <E> The type of elements in the collection.
* @param collection the collection to stream or null.
* @return {@link Collection#stream()} or {@link Stream#empty()} if the
collection is null.
* @since 3.13.0
@@ -691,7 +691,7 @@ public static <E> Stream<E> of(final Enumeration<E>
enumeration) {
/**
* Creates a sequential stream on the given Iterable.
*
- * @param <E> the type of elements in the Iterable.
+ * @param <E> The type of elements in the Iterable.
* @param iterable the Iterable to stream or null.
* @return a new Stream or {@link Stream#empty()} if the Iterable is null.
* @since 3.13.0
@@ -703,7 +703,7 @@ public static <E> Stream<E> of(final Iterable<E> iterable) {
/**
* Creates a sequential stream on the given Iterator.
*
- * @param <E> the type of elements in the Iterator.
+ * @param <E> The type of elements in the Iterator.
* @param iterator the Iterator to stream or null.
* @return a new Stream or {@link Stream#empty()} if the Iterator is null.
* @since 3.13.0
@@ -715,7 +715,7 @@ public static <E> Stream<E> of(final Iterator<E> iterator) {
/**
* Returns the stream or {@link Stream#empty()} if the stream is null.
*
- * @param <E> the type of elements in the collection.
+ * @param <E> The type of elements in the collection.
* @param stream the stream to stream or null.
* @return the stream or {@link Stream#empty()} if the stream is null.
* @since 3.13.0
@@ -727,7 +727,7 @@ private static <E> Stream<E> of(final Stream<E> stream) {
/**
* Null-safe version of {@link Stream#of(Object[])}.
*
- * @param <T> the type of stream elements.
+ * @param <T> The type of stream elements.
* @param values the elements of the new stream, may be {@code null}.
* @return the new stream on {@code values} or {@link Stream#empty()}.
* @since 3.13.0
@@ -834,7 +834,7 @@ private static <T> Stream<T> streamOf(final T value) {
/**
* Returns a {@link Collector} that accumulates the input elements into a
new array.
*
- * @param <T> the type of the input elements
+ * @param <T> The type of the input elements
* @param elementType Type of an element in the array.
* @return a {@link Collector} which collects all the input elements into
an array, in encounter order
*/
diff --git a/src/main/java/org/apache/commons/lang3/text/StrLookup.java
b/src/main/java/org/apache/commons/lang3/text/StrLookup.java
index 885707c4e..f0135e94a 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrLookup.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrLookup.java
@@ -49,7 +49,7 @@ public abstract class StrLookup<V> {
/**
* Lookup implementation that uses a Map.
*
- * @param <V> the type of mapped values.
+ * @param <V> The type of mapped values.
*/
private static final class MapStrLookup<V> extends StrLookup<V> {
@@ -115,7 +115,7 @@ public String lookup(final String key) {
* The map result object is converted to a string using toString().
* </p>
*
- * @param <V> the type of the values supported by the lookup.
+ * @param <V> The type of the values supported by the lookup.
* @param map the map of keys to values, may be null.
* @return a lookup using the map, not null.
*/
diff --git a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
index ec0dc4431..3fcc6a0d8 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
@@ -174,7 +174,7 @@ public class StrSubstitutor {
* Replaces all the occurrences of variables in the given source object
with
* their matching values from the map.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param source the source text containing the variables to substitute,
null returns null.
* @param valueMap the map with the values, may be null.
* @return the result of the replace operation.
@@ -188,7 +188,7 @@ public static <V> String replace(final Object source, final
Map<String, V> value
* their matching values from the map. This method allows to specify a
* custom variable prefix and suffix.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param source the source text containing the variables to substitute,
null returns null.
* @param valueMap the map with the values, may be null.
* @param prefix the prefix of variables, not null.
@@ -280,7 +280,7 @@ public StrSubstitutor() {
* Creates a new instance and initializes it. Uses defaults for variable
* prefix and suffix and the escaping character.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
*/
public <V> StrSubstitutor(final Map<String, V> valueMap) {
@@ -290,7 +290,7 @@ public <V> StrSubstitutor(final Map<String, V> valueMap) {
/**
* Creates a new instance and initializes it. Uses a default escaping
character.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
@@ -303,7 +303,7 @@ public <V> StrSubstitutor(final Map<String, V> valueMap,
final String prefix, fi
/**
* Creates a new instance and initializes it.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
@@ -317,7 +317,7 @@ public <V> StrSubstitutor(final Map<String, V> valueMap,
final String prefix, fi
/**
* Creates a new instance and initializes it.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
diff --git a/src/main/java/org/apache/commons/lang3/time/DatePrinter.java
b/src/main/java/org/apache/commons/lang3/time/DatePrinter.java
index 5cda1a43f..605148f4b 100644
--- a/src/main/java/org/apache/commons/lang3/time/DatePrinter.java
+++ b/src/main/java/org/apache/commons/lang3/time/DatePrinter.java
@@ -54,7 +54,7 @@ public interface DatePrinter {
*
* @param calendar the calendar to format.
* @param buf the buffer to format into.
- * @param <B> the Appendable class type, usually StringBuilder or
StringBuffer.
+ * @param <B> The Appendable class type, usually StringBuilder or
StringBuffer.
* @return the specified string buffer.
* @since 3.5
*/
@@ -88,7 +88,7 @@ public interface DatePrinter {
*
* @param date the date to format.
* @param buf the buffer to format into.
- * @param <B> the Appendable class type, usually StringBuilder or
StringBuffer.
+ * @param <B> The Appendable class type, usually StringBuilder or
StringBuffer.
* @return the specified string buffer.
* @since 3.5
*/
@@ -121,7 +121,7 @@ public interface DatePrinter {
*
* @param millis the millisecond value to format.
* @param buf the buffer to format into.
- * @param <B> the Appendable class type, usually StringBuilder or
StringBuffer.
+ * @param <B> The Appendable class type, usually StringBuilder or
StringBuffer.
* @return the specified string buffer.
* @since 3.5
*/
diff --git a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
index 42a309f02..b05f6b194 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
@@ -1068,7 +1068,7 @@ protected FastDatePrinter(final String pattern, final
TimeZone timeZone, final L
*
* @param calendar the calendar to format.
* @param buf the buffer to format into.
- * @param <B> the Appendable class type, usually StringBuilder or
StringBuffer.
+ * @param <B> The Appendable class type, usually StringBuilder or
StringBuffer.
* @return the specified string buffer.
*/
private <B extends Appendable> B applyRules(final Calendar calendar, final
B buf) {
diff --git a/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
b/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
index 7451b7197..00eda381c 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
@@ -28,8 +28,8 @@
*
* <p>#ThreadSafe# if both paired objects are thread-safe</p>
*
- * @param <L> the left element type
- * @param <R> the right element type
+ * @param <L> The left element type
+ * @param <R> The right element type
* @since 3.0
*/
public class ImmutablePair<L, R> extends Pair<L, R> {
@@ -57,8 +57,8 @@ public class ImmutablePair<L, R> extends Pair<L, R> {
/**
* Returns the empty array singleton that can be assigned without compiler
warning.
*
- * @param <L> the left element type
- * @param <R> the right element type
+ * @param <L> The left element type
+ * @param <R> The right element type
* @return the empty array singleton that can be assigned without compiler
warning.
* @since 3.10
*/
@@ -70,8 +70,8 @@ public static <L, R> ImmutablePair<L, R>[] emptyArray() {
/**
* Creates an immutable pair of two objects inferring the generic types.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param left the left element, may be null.
* @return an immutable formed from the two parameters, not null.
* @since 3.11
@@ -83,8 +83,8 @@ public static <L, R> Pair<L, R> left(final L left) {
/**
* Returns an immutable pair of nulls.
*
- * @param <L> the left element of this pair. Value is {@code null}.
- * @param <R> the right element of this pair. Value is {@code null}.
+ * @param <L> The left element of this pair. Value is {@code null}.
+ * @param <R> The right element of this pair. Value is {@code null}.
* @return an immutable pair of nulls.
* @since 3.6
*/
@@ -96,8 +96,8 @@ public static <L, R> ImmutablePair<L, R> nullPair() {
/**
* Creates an immutable pair of two objects inferring the generic types.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param left the left element, may be null.
* @param right the right element, may be null.
* @return an immutable formed from the two parameters, not null.
@@ -109,8 +109,8 @@ public static <L, R> ImmutablePair<L, R> of(final L left,
final R right) {
/**
* Creates an immutable pair from a map entry.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param pair the existing map entry.
* @return an immutable formed from the map entry.
* @since 3.10
@@ -122,8 +122,8 @@ public static <L, R> ImmutablePair<L, R> of(final
Map.Entry<L, R> pair) {
/**
* Creates an immutable pair of two non-null objects inferring the generic
types.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param left the left element, may not be null.
* @param right the right element, may not be null.
* @return an immutable formed from the two parameters, not null.
@@ -137,8 +137,8 @@ public static <L, R> ImmutablePair<L, R> ofNonNull(final L
left, final R right)
/**
* Creates an immutable pair of two objects inferring the generic types.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param right the right element, may be null.
* @return an immutable formed from the two parameters, not null.
* @since 3.11
diff --git a/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java
b/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java
index 6cdbef0f3..9a0c58f42 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java
@@ -27,9 +27,9 @@
*
* <p>#ThreadSafe# if all three objects are thread-safe.</p>
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @since 3.2
*/
public class ImmutableTriple<L, M, R> extends Triple<L, M, R> {
@@ -57,9 +57,9 @@ public class ImmutableTriple<L, M, R> extends Triple<L, M, R>
{
/**
* Gets the empty array singleton that can be assigned without compiler
warning.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @return the empty array singleton that can be assigned without compiler
warning.
* @since 3.10
*/
@@ -71,9 +71,9 @@ public static <L, M, R> ImmutableTriple<L, M, R>[]
emptyArray() {
/**
* Gets the immutable triple of nulls singleton.
*
- * @param <L> the left element of this triple. Value is {@code null}.
- * @param <M> the middle element of this triple. Value is {@code null}.
- * @param <R> the right element of this triple. Value is {@code null}.
+ * @param <L> The left element of this triple. Value is {@code null}.
+ * @param <M> The middle element of this triple. Value is {@code null}.
+ * @param <R> The right element of this triple. Value is {@code null}.
* @return an immutable triple of nulls.
* @since 3.6
*/
@@ -85,9 +85,9 @@ public static <L, M, R> ImmutableTriple<L, M, R> nullTriple()
{
/**
* Creates an immutable triple of three objects inferring the generic
types.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @param left the left element, may be null.
* @param middle the middle element, may be null.
* @param right the right element, may be null.
@@ -100,9 +100,9 @@ public static <L, M, R> ImmutableTriple<L, M, R> of(final L
left, final M middle
/**
* Creates an immutable triple of three non-null objects inferring the
generic types.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @param left the left element, may not be null.
* @param middle the middle element, may not be null.
* @param right the right element, may not be null.
diff --git a/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
b/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
index 8f8050c1e..014be8f3a 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
@@ -24,8 +24,8 @@
*
* <p>Not #ThreadSafe#</p>
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @since 3.0
*/
public class MutablePair<L, R> extends Pair<L, R> {
@@ -46,8 +46,8 @@ public class MutablePair<L, R> extends Pair<L, R> {
/**
* Returns the empty array singleton that can be assigned without compiler
warning.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @return the empty array singleton that can be assigned without compiler
warning.
* @since 3.10
*/
@@ -59,8 +59,8 @@ public static <L, R> MutablePair<L, R>[] emptyArray() {
/**
* Creates a mutable pair of two objects inferring the generic types.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param left the left element, may be null.
* @param right the right element, may be null.
* @return a mutable pair formed from the two parameters, not null.
@@ -72,8 +72,8 @@ public static <L, R> MutablePair<L, R> of(final L left, final
R right) {
/**
* Creates a mutable pair from a map entry.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param pair the existing map entry.
* @return a mutable pair formed from the map entry.
*/
@@ -93,8 +93,8 @@ public static <L, R> MutablePair<L, R> of(final Map.Entry<L,
R> pair) {
/**
* Creates a mutable pair of two non-null objects inferring the generic
types.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param left the left element, may not be null.
* @param right the right element, may not be null.
* @return a mutable pair formed from the two parameters, not null.
@@ -108,8 +108,8 @@ public static <L, R> MutablePair<L, R> ofNonNull(final L
left, final R right) {
/**
* Creates a mutable pair from a map entry.
*
- * @param <L> the left element type
- * @param <R> the right element type
+ * @param <L> The left element type
+ * @param <R> The right element type
* @param pair the existing map entry.
* @return a mutable pair formed from the map entry
* @throws NullPointerException if the pair is null.
diff --git a/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java
b/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java
index b960931dc..1e04afa8c 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java
@@ -23,9 +23,9 @@
*
* <p>Not #ThreadSafe#</p>
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @since 3.2
*/
public class MutableTriple<L, M, R> extends Triple<L, M, R> {
@@ -46,9 +46,9 @@ public class MutableTriple<L, M, R> extends Triple<L, M, R> {
/**
* Returns the empty array singleton that can be assigned without compiler
warning.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @return the empty array singleton that can be assigned without compiler
warning.
* @since 3.10
*/
@@ -60,9 +60,9 @@ public static <L, M, R> MutableTriple<L, M, R>[] emptyArray()
{
/**
* Obtains a mutable triple of three objects inferring the generic types.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @param left the left element, may be null.
* @param middle the middle element, may be null.
* @param right the right element, may be null.
@@ -75,9 +75,9 @@ public static <L, M, R> MutableTriple<L, M, R> of(final L
left, final M middle,
/**
* Obtains a mutable triple of three non-null objects inferring the
generic types.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @param left the left element, may not be null.
* @param middle the middle element, may not be null.
* @param right the right element, may not be null.
diff --git a/src/main/java/org/apache/commons/lang3/tuple/Pair.java
b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
index aff5d9506..833c180a7 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/Pair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
@@ -35,8 +35,8 @@
* However, there is no restriction on the type of the stored objects that may
be stored.
* If mutable objects are stored in the pair, then the pair itself effectively
becomes mutable.</p>
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @since 3.0
*/
public abstract class Pair<L, R> implements Map.Entry<L, R>,
Comparable<Pair<L, R>>, Serializable {
@@ -57,8 +57,8 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>,
Comparable<Pair<L,
/**
* Returns the empty array singleton that can be assigned without compiler
warning.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @return the empty array singleton that can be assigned without compiler
warning.
* @since 3.10
*/
@@ -70,8 +70,8 @@ public static <L, R> Pair<L, R>[] emptyArray() {
/**
* Creates an immutable pair of two objects inferring the generic types.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param left the left element, may be null.
* @param right the right element, may be null.
* @return an immutable pair formed from the two parameters, not null.
@@ -83,8 +83,8 @@ public static <L, R> Pair<L, R> of(final L left, final R
right) {
/**
* Creates an immutable pair from a map entry.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param pair the map entry.
* @return an immutable pair formed from the map entry.
* @since 3.10
@@ -96,8 +96,8 @@ public static <L, R> Pair<L, R> of(final Map.Entry<L, R>
pair) {
/**
* Creates an immutable pair of two non-null objects inferring the generic
types.
*
- * @param <L> the left element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <R> The right element type.
* @param left the left element, may not be null.
* @param right the right element, may not be null.
* @return an immutable pair formed from the two parameters, not null.
diff --git a/src/main/java/org/apache/commons/lang3/tuple/Triple.java
b/src/main/java/org/apache/commons/lang3/tuple/Triple.java
index 311f181c3..2d61a5aaa 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/Triple.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/Triple.java
@@ -31,9 +31,9 @@
* However, there is no restriction on the type of the stored objects that may
be stored.
* If mutable objects are stored in the triple, then the triple itself
effectively becomes mutable.</p>
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @since 3.2
*/
public abstract class Triple<L, M, R> implements Comparable<Triple<L, M, R>>,
Serializable {
@@ -54,9 +54,9 @@ public abstract class Triple<L, M, R> implements
Comparable<Triple<L, M, R>>, Se
/**
* Returns the empty array singleton that can be assigned without compiler
warning.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @return the empty array singleton that can be assigned without compiler
warning.
* @since 3.10
*/
@@ -68,9 +68,9 @@ public static <L, M, R> Triple<L, M, R>[] emptyArray() {
/**
* Obtains an immutable triple of three objects inferring the generic
types.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @param left the left element, may be null.
* @param middle the middle element, may be null.
* @param right the right element, may be null.
@@ -83,9 +83,9 @@ public static <L, M, R> Triple<L, M, R> of(final L left,
final M middle, final R
/**
* Obtains an immutable triple of three non-null objects inferring the
generic types.
*
- * @param <L> the left element type.
- * @param <M> the middle element type.
- * @param <R> the right element type.
+ * @param <L> The left element type.
+ * @param <M> The middle element type.
+ * @param <R> The right element type.
* @param left the left element, may not be null.
* @param middle the middle element, may not be null.
* @param right the right element, may not be null.
