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 03d6523e Javadoc
03d6523e is described below
commit 03d6523e908cabe93d8c3bf30f17a8c65eefc6ea
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Jun 30 14:03:57 2026 +0000
Javadoc
---
.../java/org/apache/commons/pool2/PoolUtils.java | 48 +++++++++++-----------
.../org/apache/commons/pool2/PooledObject.java | 4 +-
.../commons/pool2/impl/DefaultEvictionPolicy.java | 2 +-
.../commons/pool2/impl/DefaultPooledObject.java | 2 +-
.../apache/commons/pool2/impl/EvictionPolicy.java | 2 +-
.../commons/pool2/impl/LinkedBlockingDeque.java | 2 +-
.../commons/pool2/impl/PooledSoftReference.java | 2 +-
.../pool2/impl/TestGenericKeyedObjectPool.java | 2 +-
.../commons/pool2/impl/TestGenericObjectPool.java | 2 +-
9 files changed, 33 insertions(+), 33 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/PoolUtils.java
b/src/main/java/org/apache/commons/pool2/PoolUtils.java
index 9ee89420..40d6196e 100644
--- a/src/main/java/org/apache/commons/pool2/PoolUtils.java
+++ b/src/main/java/org/apache/commons/pool2/PoolUtils.java
@@ -1343,8 +1343,8 @@ public final class PoolUtils {
* @param periodMillis
* the frequency in milliseconds to check the number of idle
objects in a
* keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @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
* periodically check the pools idle object count.
* @throws IllegalArgumentException
@@ -1382,8 +1382,8 @@ public final class PoolUtils {
* @param periodMillis
* the frequency in milliseconds to check the number of idle
objects in a
* keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
* @return the {@link TimerTask} that will periodically check the pools
idle
* object count.
* @throws IllegalArgumentException
@@ -1423,7 +1423,7 @@ public final class PoolUtils {
* @param periodMillis
* the frequency in milliseconds to check the number of idle
objects in a pool,
* see {@link Timer#schedule(TimerTask, long, long)}.
- * @param <T> the type of objects in the pool
+ * @param <T> The type of objects in the pool
* @return the {@link TimerTask} that will periodically check the pools
idle
* object count.
* @throws IllegalArgumentException
@@ -1478,8 +1478,8 @@ public final class PoolUtils {
* @param keyedPool
* the KeyedObjectPool to be decorated so it shrinks its idle
* count when possible.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @param <K> The type of the pool key
+ * @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
@@ -1512,8 +1512,8 @@ public final class PoolUtils {
* reduce its size. If 0 < factor < 1 then the pool
* shrinks more aggressively. If 1 < factor then the pool
* shrinks less aggressively.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null} or when {@code
factor}
* is not positive.
@@ -1554,8 +1554,8 @@ public final class PoolUtils {
* shrinks less aggressively.
* @param perKey
* when true, each key is treated independently.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null} or when {@code
factor}
* is not positive.
@@ -1589,7 +1589,7 @@ public final class PoolUtils {
* @param pool
* the ObjectPool to be decorated so it shrinks its idle count
* when possible.
- * @param <T> the type of objects in the pool
+ * @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
@@ -1621,7 +1621,7 @@ public final class PoolUtils {
* reduce its size. If 0 < factor < 1 then the pool
* shrinks more aggressively. If 1 < factor then the pool
* shrinks less aggressively.
- * @param <T> the type of objects in the pool
+ * @param <T> The type of objects in the pool
* @throws IllegalArgumentException
* when {@code pool} is {@code null} or when {@code factor} is
* not positive.
@@ -1660,8 +1660,8 @@ public final class PoolUtils {
* {@link Collection} of keys to add objects for.
* @param count
* the number of idle objects to add for each {@code key}.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
* @throws Exception
* when {@link KeyedObjectPool#addObject(Object)} fails.
* @throws IllegalArgumentException
@@ -1690,8 +1690,8 @@ public final class PoolUtils {
* the key to add objects for.
* @param count
* the number of idle objects to add for {@code key}.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
* @throws Exception
* when {@link KeyedObjectPool#addObject(Object)} fails.
* @throws IllegalArgumentException
@@ -1716,7 +1716,7 @@ public final class PoolUtils {
* the pool to prefill.
* @param count
* the number of idle objects to add.
- * @param <T> the type of objects in the pool
+ * @param <T> The type of objects in the pool
* @throws Exception
* when {@link ObjectPool#addObject()} fails.
* @throws IllegalArgumentException
@@ -1739,8 +1739,8 @@ public final class PoolUtils {
* @param keyedFactory
* the KeyedPooledObjectFactory to be "wrapped" in a
* synchronized KeyedPooledObjectFactory.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
* @return a synchronized view of the specified KeyedPooledObjectFactory.
*/
public static <K, V> KeyedPooledObjectFactory<K, V>
synchronizedKeyedPooledFactory(
@@ -1763,8 +1763,8 @@ public final class PoolUtils {
* @param keyedPool
* the KeyedObjectPool to be "wrapped" in a synchronized
* KeyedObjectPool.
- * @param <K> the type of the pool key
- * @param <V> the type of pool entries
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
* @return a synchronized view of the specified KeyedObjectPool.
*/
public static <K, V> KeyedObjectPool<K, V> synchronizedPool(final
KeyedObjectPool<K, V> keyedPool) {
@@ -1792,7 +1792,7 @@ public final class PoolUtils {
* deadlock.
* </p>
*
- * @param <T> the type of objects in the pool
+ * @param <T> The type of objects in the pool
* @param pool
* the ObjectPool to be "wrapped" in a synchronized ObjectPool.
* @throws IllegalArgumentException
@@ -1825,7 +1825,7 @@ public final class PoolUtils {
* @param factory
* the PooledObjectFactory to be "wrapped" in a synchronized
* PooledObjectFactory.
- * @param <T> the type of objects in the pool
+ * @param <T> The type of objects in the pool
* @return a synchronized view of the specified PooledObjectFactory.
*/
public static <T> PooledObjectFactory<T> synchronizedPooledFactory(final
PooledObjectFactory<T> factory) {
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java
b/src/main/java/org/apache/commons/pool2/PooledObject.java
index e68fe085..5d301107 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -28,7 +28,7 @@ import java.util.Deque;
* Implementations of this class are required to be thread-safe.
* </p>
*
- * @param <T> the type of object in the pool.
+ * @param <T> The type of object in the pool.
* @since 2.0
*/
public interface PooledObject<T> extends Comparable<PooledObject<T>> {
@@ -36,7 +36,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
/**
* Gets the wrapped object or null.
*
- * @param <T> the type of object in the pool.
+ * @param <T> The type of object in the pool.
* @param pooledObject the PooledObject to unwrap, may be null.
* @return the wrapped object or null.
* @since 2.13.0
diff --git
a/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
b/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
index 0ed88b18..ce727ce9 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
@@ -37,7 +37,7 @@ import org.apache.commons.pool2.PooledObject;
* This class is immutable and thread-safe.
* </p>
*
- * @param <T> the type of objects in the pool.
+ * @param <T> The type of objects in the pool.
* @since 2.0
*/
public class DefaultEvictionPolicy<T> implements EvictionPolicy<T> {
diff --git
a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
index 07a93b89..9acb7d4f 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
@@ -33,7 +33,7 @@ import org.apache.commons.pool2.TrackedUse;
* This class is intended to be thread-safe.
* </p>
*
- * @param <T> the type of object in the pool
+ * @param <T> The type of object in the pool
* @since 2.0
*/
public class DefaultPooledObject<T> implements PooledObject<T> {
diff --git a/src/main/java/org/apache/commons/pool2/impl/EvictionPolicy.java
b/src/main/java/org/apache/commons/pool2/impl/EvictionPolicy.java
index 55596a27..51406521 100644
--- a/src/main/java/org/apache/commons/pool2/impl/EvictionPolicy.java
+++ b/src/main/java/org/apache/commons/pool2/impl/EvictionPolicy.java
@@ -23,7 +23,7 @@ import org.apache.commons.pool2.PooledObject;
* DefaultEvictionPolicy} for a pool, users must provide an implementation of
* this interface that provides the required eviction policy.
*
- * @param <T> the type of objects in the pool.
+ * @param <T> The type of objects in the pool.
* @since 2.0
*/
public interface EvictionPolicy<T> {
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 80d03975..e982f5a6 100644
--- a/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
@@ -58,7 +58,7 @@ import java.util.concurrent.locks.Condition;
* Java Collections Framework</a>.
* </p>
*
- * @param <E> the type of elements held in this collection
+ * @param <E> The type of elements held in this collection
*
* Note: This was copied from Apache Harmony and modified to suit the needs of
* Commons Pool.
diff --git
a/src/main/java/org/apache/commons/pool2/impl/PooledSoftReference.java
b/src/main/java/org/apache/commons/pool2/impl/PooledSoftReference.java
index 1b5fb0be..bf38d8d7 100644
--- a/src/main/java/org/apache/commons/pool2/impl/PooledSoftReference.java
+++ b/src/main/java/org/apache/commons/pool2/impl/PooledSoftReference.java
@@ -23,7 +23,7 @@ import java.lang.ref.SoftReference;
*
* <p>This class is intended to be thread-safe.</p>
*
- * @param <T> the type of the underlying object that the wrapped SoftReference
+ * @param <T> The type of the underlying object that the wrapped SoftReference
* refers to.
*
* @since 2.0
diff --git
a/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
b/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
index 0e78f5d9..9f6e687f 100644
---
a/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
+++
b/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
@@ -328,7 +328,7 @@ public class TestGenericKeyedObjectPool extends
AbstractTestKeyedObjectPool {
/**
* DefaultEvictionPolicy modified to add latency.
*
- * @param <T> the type of objects in the pool.
+ * @param <T> The type of objects in the pool.
*/
private static final class SlowEvictionPolicy<T> extends
DefaultEvictionPolicy<T> {
private final long delay;
diff --git
a/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java
b/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java
index bfaa8e7f..5cd5151c 100644
--- a/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java
+++ b/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java
@@ -433,7 +433,7 @@ class TestGenericObjectPool extends TestBaseObjectPool {
/**
* Must not be public for the test to instantiate this class through
reflection.
*
- * @param <T> the type of objects in the pool.
+ * @param <T> The type of objects in the pool.
*/
public static class TestEvictionPolicy<T> implements EvictionPolicy<T> {
private final AtomicInteger callCount = new AtomicInteger();
