This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
commit 8c9195be3c1f76c1d9283a2b2d414f0ad1175c04
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Nov 16 09:27:27 2024 -0500
Javadoc: More precise generic type documentation
---
.../java/org/apache/commons/lang3/builder/AbstractSupplier.java | 2 +-
.../commons/lang3/concurrent/AbstractConcurrentInitializer.java | 6 +++---
.../java/org/apache/commons/lang3/concurrent/AtomicInitializer.java | 4 ++--
.../org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java | 4 ++--
.../org/apache/commons/lang3/concurrent/BackgroundInitializer.java | 4 ++--
.../java/org/apache/commons/lang3/concurrent/LazyInitializer.java | 4 ++--
.../java/org/apache/commons/lang3/function/FailableSupplier.java | 2 +-
7 files changed, 13 insertions(+), 13 deletions(-)
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 16532191d..3f8104973 100644
--- a/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
+++ b/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
@@ -22,7 +22,7 @@ import org.apache.commons.lang3.function.FailableSupplier;
/**
* Abstracts supplying an instance of {@code T}. Use to implement the builder
pattern.
*
- * @param <T> the type of instances to build.
+ * @param <T> The type of results supplied by this supplier.
* @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/concurrent/AbstractConcurrentInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
index 89004f306..2a7580bb7 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
@@ -36,9 +36,9 @@ public abstract class AbstractConcurrentInitializer<T, E
extends Exception> impl
/**
* Builds a new instance for subclasses.
*
- * @param <T> the type of the object managed by the initializer class.
- * @param <I> the type of the initializer class.
- * @param <B> the type of builder.
+ * @param <I> The type of results supplied by this builder.
+ * @param <T> The type of the object managed by the initializer class.
+ * @param <B> The type of builder.
* @param <E> The exception type thrown by {@link #initialize()}.
*/
public abstract static class AbstractBuilder<I extends
AbstractConcurrentInitializer<T, E>, T, B extends AbstractBuilder<I, T, B, E>,
E extends Exception>
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 b06fa8aff..aa4d79f38 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
@@ -70,8 +70,8 @@ public class AtomicInitializer<T> extends
AbstractConcurrentInitializer<T, Concu
/**
* Builds a new instance.
*
- * @param <T> the type of the object managed by the initializer.
- * @param <I> the type of the initializer managed by this builder.
+ * @param <T> The type of results supplied by this builder.
+ * @param <I> The type of the initializer managed by this builder.
* @since 3.14.0
*/
public static class Builder<I extends AtomicInitializer<T>, T> extends
AbstractBuilder<I, T, Builder<I, T>, ConcurrentException> {
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 b803432c1..d16befa88 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
@@ -59,8 +59,8 @@ public class AtomicSafeInitializer<T> extends
AbstractConcurrentInitializer<T, C
/**
* Builds a new instance.
*
- * @param <T> the type of the object managed by the initializer.
- * @param <I> the type of the initializer managed by this builder.
+ * @param <T> The type of results supplied by this builder.
+ * @param <I> The type of the initializer managed by this builder.
* @since 3.14.0
*/
public static class Builder<I extends AtomicSafeInitializer<T>, T> extends
AbstractBuilder<I, T, Builder<I, T>, ConcurrentException> {
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 613c85fb1..4d6244c85 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
@@ -90,8 +90,8 @@ public class BackgroundInitializer<T> extends
AbstractConcurrentInitializer<T, E
/**
* Builds a new instance.
*
- * @param <T> the type of the object managed by the initializer.
- * @param <I> the type of the initializer managed by this builder.
+ * @param <T> The type of results supplied by this builder.
+ * @param <I> The type of the initializer managed by this builder.
* @since 3.14.0
*/
public static class Builder<I extends BackgroundInitializer<T>, T> extends
AbstractBuilder<I, T, Builder<I, T>, Exception> {
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 271a97afb..2397d17a5 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
@@ -74,8 +74,8 @@ public class LazyInitializer<T> extends
AbstractConcurrentInitializer<T, Concurr
/**
* Builds a new instance.
*
- * @param <T> the type of the object managed by the initializer.
- * @param <I> the type of the initializer managed by this builder.
+ * @param <T> The type of results supplied by this builder.
+ * @param <I> The type of the initializer managed by this builder.
* @since 3.14.0
*/
public static class Builder<I extends LazyInitializer<T>, T> extends
AbstractBuilder<I, T, Builder<I, T>, ConcurrentException> {
diff --git
a/src/main/java/org/apache/commons/lang3/function/FailableSupplier.java
b/src/main/java/org/apache/commons/lang3/function/FailableSupplier.java
index 6b12de3c0..9fdd52af6 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableSupplier.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableSupplier.java
@@ -22,7 +22,7 @@ import java.util.function.Supplier;
/**
* A functional interface like {@link Supplier} that declares a {@link
Throwable}.
*
- * @param <T> Return type.
+ * @param <T> The type of results supplied by this supplier.
* @param <E> The kind of thrown exception or error.
* @since 3.11
*/
