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-pool.git
The following commit(s) were added to refs/heads/master by this push:
new 7a63903b Javadoc
7a63903b is described below
commit 7a63903b2ff2b54b7ae6c7705a7bb97a6c0175fd
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Jun 30 14:04:16 2026 +0000
Javadoc
---
.../java/org/apache/commons/pool3/PoolUtils.java | 56 +++++++++++-----------
.../org/apache/commons/pool3/PooledObject.java | 4 +-
.../commons/pool3/impl/DefaultEvictionPolicy.java | 2 +-
.../commons/pool3/impl/DefaultPooledObject.java | 2 +-
.../apache/commons/pool3/impl/EvictionPolicy.java | 2 +-
.../commons/pool3/impl/LinkedBlockingDeque.java | 2 +-
.../commons/pool3/impl/PooledSoftReference.java | 2 +-
.../commons/pool3/proxy/AbstractProxySource.java | 4 +-
.../pool3/impl/TestGenericKeyedObjectPool.java | 2 +-
9 files changed, 38 insertions(+), 38 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool3/PoolUtils.java
b/src/main/java/org/apache/commons/pool3/PoolUtils.java
index b788ee61..f6d503c6 100644
--- a/src/main/java/org/apache/commons/pool3/PoolUtils.java
+++ b/src/main/java/org/apache/commons/pool3/PoolUtils.java
@@ -1352,9 +1352,9 @@ 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 <E> the type of exception thrown by a pool
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
+ * @param <E> The type of exception thrown by a pool
* @return a {@link Map} of key and {@link TimerTask} pairs that will
* periodically check the pools idle object count.
* @throws IllegalArgumentException
@@ -1391,9 +1391,9 @@ 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 <E> the type of exception thrown by a pool
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
+ * @param <E> The type of exception thrown by a pool
* @return the {@link TimerTask} that will periodically check the pools
idle
* object count.
* @throws IllegalArgumentException
@@ -1433,7 +1433,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
* @param <E> type of exceptions from the pool
* @return the {@link TimerTask} that will periodically check the pools
idle
* object count.
@@ -1489,9 +1489,9 @@ 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 <E> the type of exception thrown by a pool
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
+ * @param <E> The type of exception thrown by a pool
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null}.
* @return a pool that adaptively decreases its size when idle objects are
@@ -1524,9 +1524,9 @@ 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 <E> the type of exception thrown by a pool
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
+ * @param <E> The type of exception thrown by a pool
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null} or when {@code
factor}
* is not positive.
@@ -1567,9 +1567,9 @@ 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 <E> the type of exception thrown by a pool
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
+ * @param <E> The type of exception thrown by a pool
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null} or when {@code
factor}
* is not positive.
@@ -1603,7 +1603,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
* @param <E> type of exceptions from the pool
* @throws IllegalArgumentException
* when {@code pool} is {@code null}.
@@ -1636,7 +1636,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
* @param <E> type of exceptions from the pool
* @throws IllegalArgumentException
* when {@code pool} is {@code null} or when {@code factor} is
@@ -1671,9 +1671,9 @@ 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 <E> the type of pool exceptions
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
+ * @param <E> The type of pool exceptions
* @return a synchronized view of the specified KeyedPooledObjectFactory.
*/
public static <K, V, E extends Exception> KeyedPooledObjectFactory<K, V,
E> synchronizedKeyedPooledFactory(
@@ -1696,9 +1696,9 @@ 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 <E> the type of exception thrown by a pool
+ * @param <K> The type of the pool key
+ * @param <V> The type of pool entries
+ * @param <E> The type of exception thrown by a pool
* @return a synchronized view of the specified KeyedObjectPool.
*/
public static <K, V, E extends Exception> KeyedObjectPool<K, V, E>
synchronizedPool(final KeyedObjectPool<K, V, E> keyedPool) {
@@ -1726,8 +1726,8 @@ public final class PoolUtils {
* deadlock.
* </p>
*
- * @param <T> the type of objects in the pool
- * @param <E> the type of exceptions thrown by the pool
+ * @param <T> The type of objects in the pool
+ * @param <E> The type of exceptions thrown by the pool
* @param pool
* the ObjectPool to be "wrapped" in a synchronized ObjectPool.
* @throws IllegalArgumentException
@@ -1760,8 +1760,8 @@ 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 <E> the type of exceptions thrown by the pool
+ * @param <T> The type of objects in the pool
+ * @param <E> The type of exceptions thrown by the pool
* @return a synchronized view of the specified PooledObjectFactory.
*/
public static <T, E extends Exception> PooledObjectFactory<T, E>
synchronizedPooledFactory(final PooledObjectFactory<T, E> factory) {
diff --git a/src/main/java/org/apache/commons/pool3/PooledObject.java
b/src/main/java/org/apache/commons/pool3/PooledObject.java
index 43dc282e..173f7b1d 100644
--- a/src/main/java/org/apache/commons/pool3/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool3/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/pool3/impl/DefaultEvictionPolicy.java
b/src/main/java/org/apache/commons/pool3/impl/DefaultEvictionPolicy.java
index 27e41550..fa48020a 100644
--- a/src/main/java/org/apache/commons/pool3/impl/DefaultEvictionPolicy.java
+++ b/src/main/java/org/apache/commons/pool3/impl/DefaultEvictionPolicy.java
@@ -37,7 +37,7 @@ import org.apache.commons.pool3.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/pool3/impl/DefaultPooledObject.java
b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java
index 41fc6171..c332d24f 100644
--- a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java
+++ b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java
@@ -34,7 +34,7 @@ import org.apache.commons.pool3.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/pool3/impl/EvictionPolicy.java
b/src/main/java/org/apache/commons/pool3/impl/EvictionPolicy.java
index 58bc76cf..49aee70d 100644
--- a/src/main/java/org/apache/commons/pool3/impl/EvictionPolicy.java
+++ b/src/main/java/org/apache/commons/pool3/impl/EvictionPolicy.java
@@ -23,7 +23,7 @@ import org.apache.commons.pool3.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/pool3/impl/LinkedBlockingDeque.java
b/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java
index e71a8440..63c67996 100644
--- a/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool3/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/pool3/impl/PooledSoftReference.java
b/src/main/java/org/apache/commons/pool3/impl/PooledSoftReference.java
index 2c78fb6c..4217aff1 100644
--- a/src/main/java/org/apache/commons/pool3/impl/PooledSoftReference.java
+++ b/src/main/java/org/apache/commons/pool3/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/main/java/org/apache/commons/pool3/proxy/AbstractProxySource.java
b/src/main/java/org/apache/commons/pool3/proxy/AbstractProxySource.java
index fafc7022..d7e6c84d 100644
--- a/src/main/java/org/apache/commons/pool3/proxy/AbstractProxySource.java
+++ b/src/main/java/org/apache/commons/pool3/proxy/AbstractProxySource.java
@@ -32,8 +32,8 @@ public abstract class AbstractProxySource<T> implements
ProxySource<T> {
* Abstract a builder implementations.
*
* @param <T> type of the pooled object to be proxied.
- * @param <P> the AbstractProxySource subclass
- * @param <B> the builder subclass.
+ * @param <P> The AbstractProxySource subclass
+ * @param <B> The builder subclass.
*/
public abstract static class AbstractBuilder<T, P, B extends
AbstractBuilder<T, P, B>> implements Supplier<P> {
diff --git
a/src/test/java/org/apache/commons/pool3/impl/TestGenericKeyedObjectPool.java
b/src/test/java/org/apache/commons/pool3/impl/TestGenericKeyedObjectPool.java
index 16c31937..7c94ef1a 100644
---
a/src/test/java/org/apache/commons/pool3/impl/TestGenericKeyedObjectPool.java
+++
b/src/test/java/org/apache/commons/pool3/impl/TestGenericKeyedObjectPool.java
@@ -335,7 +335,7 @@ 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;
