Javadoc

Author: garydgregory

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>> {
 

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.

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}.

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

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.
      */

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) {