This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch POOL_2_X
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
The following commit(s) were added to refs/heads/POOL_2_X by this push:
new e5205451 Javadoc
e5205451 is described below
commit e520545115ed548ecc0b0fcbe607949f9aeb9d80
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:09:07 2026 -0400
Javadoc
---
.../commons/pool2/BaseKeyedPooledObjectFactory.java | 2 +-
.../org/apache/commons/pool2/BaseObjectPool.java | 4 ++--
.../commons/pool2/BasePooledObjectFactory.java | 2 +-
.../org/apache/commons/pool2/KeyedObjectPool.java | 4 ++--
.../commons/pool2/KeyedPooledObjectFactory.java | 2 +-
.../java/org/apache/commons/pool2/ObjectPool.java | 2 +-
.../java/org/apache/commons/pool2/PoolUtils.java | 20 ++++++++++----------
.../apache/commons/pool2/PooledObjectFactory.java | 2 +-
.../commons/pool2/impl/BaseGenericObjectPool.java | 4 ++--
.../apache/commons/pool2/impl/CallStackUtils.java | 4 ++--
.../commons/pool2/impl/GenericKeyedObjectPool.java | 2 +-
.../commons/pool2/impl/LinkedBlockingDeque.java | 4 ++--
.../org/apache/commons/pool2/impl/PoolImplUtils.java | 2 +-
.../commons/pool2/impl/SoftReferenceObjectPool.java | 2 +-
.../commons/pool2/proxy/ProxiedKeyedObjectPool.java | 2 +-
15 files changed, 29 insertions(+), 29 deletions(-)
diff --git
a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
index ffa379a5..975ff453 100644
--- a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
@@ -59,7 +59,7 @@ public abstract class BaseKeyedPooledObjectFactory<K, V>
extends BaseObject impl
* Creates an instance that can be served by the pool.
*
* @param key the key used when constructing the object
- * @return an instance that can be served by the pool
+ * @return An instance that can be served by the pool
* @throws Exception if there is a problem creating a new instance,
* this will be propagated to the code requesting an object.
*/
diff --git a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
index c9952d04..91054e09 100644
--- a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
@@ -92,7 +92,7 @@ public abstract class BaseObjectPool<T> extends BaseObject
implements ObjectPool
/**
* Not supported in this base implementation.
*
- * @return a negative value.
+ * @return A negative value.
*/
@Override
public int getNumActive() {
@@ -102,7 +102,7 @@ public abstract class BaseObjectPool<T> extends BaseObject
implements ObjectPool
/**
* Not supported in this base implementation.
*
- * @return a negative value.
+ * @return A negative value.
*/
@Override
public int getNumIdle() {
diff --git
a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
index 166aaa05..a9b1f3d5 100644
--- a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
@@ -54,7 +54,7 @@ public abstract class BasePooledObjectFactory<T> extends
BaseObject implements P
* <p>This method <strong>must</strong> support concurrent, multi-threaded
* invocation.</p>
*
- * @return an instance to be served by the pool, not null.
+ * @return An instance to be served by the pool, not null.
* @throws Exception if there is a problem creating a new instance,
* this will be propagated to the code requesting an object.
*/
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index 01e1690b..4e3e93cf 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -159,7 +159,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* </p>
*
* @param key the key used to obtain the object
- * @return an instance from this pool.
+ * @return An instance from this pool.
* @throws IllegalStateException
* after {@link #close close} has been called on this pool
* @throws Exception
@@ -214,7 +214,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* Implementations should override this method.
* </p>
*
- * @return a copy of the pool key list.
+ * @return A copy of the pool key list.
* @since 2.12.0
*/
default List<K> getKeys() {
diff --git
a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
index e5358ad8..a596d6fe 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
@@ -132,7 +132,7 @@ public interface KeyedPooledObjectFactory<K, V> {
* wrap it in a {@link PooledObject} to be managed by the pool.
*
* @param key the key used when constructing the object
- * @return a {@code PooledObject} wrapping an instance that can
+ * @return A {@code PooledObject} wrapping an instance that can
* be served by the pool.
*
* @throws Exception if there is a problem creating a new instance,
diff --git a/src/main/java/org/apache/commons/pool2/ObjectPool.java
b/src/main/java/org/apache/commons/pool2/ObjectPool.java
index 93d0f5d6..230909b5 100644
--- a/src/main/java/org/apache/commons/pool2/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/ObjectPool.java
@@ -109,7 +109,7 @@ public interface ObjectPool<T> extends Closeable {
* implementations).
* </p>
*
- * @return an instance from this pool.
+ * @return An instance from this pool.
* @throws IllegalStateException
* after {@link #close close} has been called on this pool.
* @throws Exception
diff --git a/src/main/java/org/apache/commons/pool2/PoolUtils.java
b/src/main/java/org/apache/commons/pool2/PoolUtils.java
index 156467cb..d86a2e72 100644
--- a/src/main/java/org/apache/commons/pool2/PoolUtils.java
+++ b/src/main/java/org/apache/commons/pool2/PoolUtils.java
@@ -1345,7 +1345,7 @@ public final class PoolUtils {
* keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.
* @param <K> The type of the pool key
* @param <V> The type of pool entries
- * @return a {@link Map} of key and {@link TimerTask} pairs that will
+ * @return A {@link Map} of key and {@link TimerTask} pairs that will
* periodically check the pools idle object count.
* @throws IllegalArgumentException
* when {@code keyedPool}, {@code keys}, or any of the values
in
@@ -1482,7 +1482,7 @@ public final class PoolUtils {
* @param <V> The type of pool entries
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null}.
- * @return a pool that adaptively decreases its size when idle objects are
+ * @return A pool that adaptively decreases its size when idle objects are
* no longer needed.
* @see #erodingPool(KeyedObjectPool, float)
* @see #erodingPool(KeyedObjectPool, float, boolean)
@@ -1517,7 +1517,7 @@ public final class PoolUtils {
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null} or when {@code
factor}
* is not positive.
- * @return a pool that adaptively decreases its size when idle objects are
+ * @return A pool that adaptively decreases its size when idle objects are
* no longer needed.
* @see #erodingPool(KeyedObjectPool, float, boolean)
*/
@@ -1559,7 +1559,7 @@ public final class PoolUtils {
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null} or when {@code
factor}
* is not positive.
- * @return a pool that adaptively decreases its size when idle objects are
+ * @return A pool that adaptively decreases its size when idle objects are
* no longer needed.
* @see #erodingPool(KeyedObjectPool)
* @see #erodingPool(KeyedObjectPool, float)
@@ -1592,7 +1592,7 @@ public final class PoolUtils {
* @param <T> The type of objects in the pool
* @throws IllegalArgumentException
* when {@code pool} is {@code null}.
- * @return a pool that adaptively decreases its size when idle objects are
+ * @return A pool that adaptively decreases its size when idle objects are
* no longer needed.
* @see #erodingPool(ObjectPool, float)
*/
@@ -1625,7 +1625,7 @@ public final class PoolUtils {
* @throws IllegalArgumentException
* when {@code pool} is {@code null} or when {@code factor} is
* not positive.
- * @return a pool that adaptively decreases its size when idle objects are
+ * @return A pool that adaptively decreases its size when idle objects are
* no longer needed.
* @see #erodingPool(ObjectPool)
*/
@@ -1741,7 +1741,7 @@ public final class PoolUtils {
* synchronized KeyedPooledObjectFactory.
* @param <K> The type of the pool key
* @param <V> The type of pool entries
- * @return a synchronized view of the specified KeyedPooledObjectFactory.
+ * @return A synchronized view of the specified KeyedPooledObjectFactory.
*/
public static <K, V> KeyedPooledObjectFactory<K, V>
synchronizedKeyedPooledFactory(
final KeyedPooledObjectFactory<K, V> keyedFactory) {
@@ -1765,7 +1765,7 @@ public final class PoolUtils {
* KeyedObjectPool.
* @param <K> The type of the pool key
* @param <V> The type of pool entries
- * @return a synchronized view of the specified KeyedObjectPool.
+ * @return A synchronized view of the specified KeyedObjectPool.
*/
public static <K, V> KeyedObjectPool<K, V> synchronizedPool(final
KeyedObjectPool<K, V> keyedPool) {
/*
@@ -1797,7 +1797,7 @@ public final class PoolUtils {
* the ObjectPool to be "wrapped" in a synchronized ObjectPool.
* @throws IllegalArgumentException
* when {@code pool} is {@code null}.
- * @return a synchronized view of the specified ObjectPool.
+ * @return A synchronized view of the specified ObjectPool.
*/
public static <T> ObjectPool<T> synchronizedPool(final ObjectPool<T> pool)
{
if (pool == null) {
@@ -1826,7 +1826,7 @@ public final class PoolUtils {
* the PooledObjectFactory to be "wrapped" in a synchronized
* PooledObjectFactory.
* @param <T> The type of objects in the pool
- * @return a synchronized view of the specified PooledObjectFactory.
+ * @return A synchronized view of the specified PooledObjectFactory.
*/
public static <T> PooledObjectFactory<T> synchronizedPooledFactory(final
PooledObjectFactory<T> factory) {
return new SynchronizedPooledObjectFactory<>(factory);
diff --git a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
index 94022c17..ac0ab031 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
@@ -126,7 +126,7 @@ public interface PooledObjectFactory<T> {
* Creates an instance that can be served by the pool and wrap it in a
* {@link PooledObject} to be managed by the pool.
*
- * @return a {@code PooledObject} wrapping an instance that can be served by
the pool, not null.
+ * @return A {@code PooledObject} wrapping an instance that can be served by
the pool, not null.
* @throws Exception if there is a problem creating a new instance,
* this will be propagated to the code requesting an object.
*/
diff --git
a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
index 0f412a7e..049f206c 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
@@ -213,7 +213,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
*
* @param <T> The type of the object in the {@link PooledObject}.
* @param p The {@link PooledObject}.
- * @return a new instance.
+ * @return A new instance.
*/
static <T> IdentityWrapper<T> unwrap(final PooledObject<T> p) {
return new IdentityWrapper<>(p.getObject());
@@ -481,7 +481,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
*
* @param abandonedConfig The abandoned configuration.
* @param allObjects PooledObject instances to consider.
- * @return a list of pooled objects to remove based on their state.
+ * @return A list of pooled objects to remove based on their state.
*/
ArrayList<PooledObject<T>> createRemoveList(final AbandonedConfig
abandonedConfig, final Map<IdentityWrapper<T>, PooledObject<T>> allObjects) {
final Instant timeout =
Instant.now().minus(abandonedConfig.getRemoveAbandonedTimeoutDuration());
diff --git a/src/main/java/org/apache/commons/pool2/impl/CallStackUtils.java
b/src/main/java/org/apache/commons/pool2/impl/CallStackUtils.java
index d4e2fced..9c3fca9a 100644
--- a/src/main/java/org/apache/commons/pool2/impl/CallStackUtils.java
+++ b/src/main/java/org/apache/commons/pool2/impl/CallStackUtils.java
@@ -50,7 +50,7 @@ public final class CallStackUtils {
* @param messageFormat message (or format) to print first in stack traces
* @param useTimestamp if true, interpret message as a SimpleDateFormat
and print the created timestamp; otherwise,
* print message format literally
- * @return a new CallStack
+ * @return A new CallStack
* @deprecated Use {@link #newCallStack(String, boolean, boolean)}
*/
@Deprecated
@@ -66,7 +66,7 @@ public final class CallStackUtils {
* otherwise, print message format literally
* @param requireFullStackTrace if true, forces the use of a stack walking
mechanism that includes full stack trace
* information; otherwise, uses a faster
implementation if possible
- * @return a new CallStack
+ * @return A new CallStack
* @since 2.5
*/
public static CallStack newCallStack(final String messageFormat,
diff --git
a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
index e7061d1e..b8ff4a49 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
@@ -1212,7 +1212,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
/**
* Gets a copy of the pool key list.
*
- * @return a copy of the pool key list.
+ * @return A copy of the pool key list.
* @since 2.12.0
*/
@Override
diff --git
a/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
b/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
index 1f5a0f9b..15a23df9 100644
--- a/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
@@ -627,7 +627,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* construction of the iterator, and may (but is not guaranteed to)
* reflect any modifications subsequent to construction.
*
- * @return an iterator over the elements in this deque in proper sequence
+ * @return An iterator over the elements in this deque in proper sequence
*/
@Override
public Iterator<E> iterator() {
@@ -1362,7 +1362,7 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
* APIs.
* </p>
*
- * @return an array containing all of the elements in this deque
+ * @return An array containing all of the elements in this deque
*/
@Override
public Object[] toArray() {
diff --git a/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
b/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
index abbf60a1..41c5e7f0 100644
--- a/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
+++ b/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
@@ -221,7 +221,7 @@ final class PoolImplUtils {
*
* @param amount the amount of the duration, measured in terms of the
unit, positive or negative
* @param timeUnit the unit that the duration is measured in, must have an
exact duration, not null
- * @return a Duration.
+ * @return A Duration.
*/
static Duration toDuration(final long amount, final TimeUnit timeUnit) {
return Duration.of(amount, toChronoUnit(timeUnit));
diff --git
a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
index 452ccdc6..780d824d 100644
--- a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
@@ -170,7 +170,7 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
* if invoked on a {@link #close() closed} pool
* @throws Exception
* if an exception occurs creating a new instance
- * @return a valid, activated object instance
+ * @return A valid, activated object instance
*/
@SuppressWarnings("null") // ref cannot be null
@Override
diff --git
a/src/main/java/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.java
index a97de7f2..2951ab60 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.java
@@ -81,7 +81,7 @@ public class ProxiedKeyedObjectPool<K, V> implements
KeyedObjectPool<K, V> {
/**
* Gets a copy of the pool key list.
*
- * @return a copy of the pool key list.
+ * @return A copy of the pool key list.
* @since 2.12.0
*/
@Override
