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 190aa384 Javadoc
190aa384 is described below
commit 190aa38422fe3597880f48ca07d41692384a573f
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:43 2026 -0400
Javadoc
---
.../pool2/BaseKeyedPooledObjectFactory.java | 20 ++++++++++----------
.../commons/pool2/BasePooledObjectFactory.java | 2 +-
.../org/apache/commons/pool2/KeyedObjectPool.java | 22 +++++++++++-----------
.../commons/pool2/KeyedPooledObjectFactory.java | 22 +++++++++++-----------
.../java/org/apache/commons/pool2/ObjectPool.java | 6 +++---
.../org/apache/commons/pool2/PooledObject.java | 8 ++++----
.../apache/commons/pool2/PooledObjectFactory.java | 10 +++++-----
.../apache/commons/pool2/impl/AbandonedConfig.java | 4 ++--
.../commons/pool2/impl/BaseGenericObjectPool.java | 20 ++++++++++----------
.../org/apache/commons/pool2/impl/CallStack.java | 2 +-
.../commons/pool2/impl/DefaultPooledObject.java | 2 +-
.../apache/commons/pool2/impl/EvictionTimer.java | 2 +-
.../commons/pool2/impl/GenericKeyedObjectPool.java | 16 ++++++++--------
.../commons/pool2/impl/GenericObjectPool.java | 4 ++--
.../pool2/impl/InterruptibleReentrantLock.java | 2 +-
.../commons/pool2/impl/LinkedBlockingDeque.java | 10 +++++-----
.../apache/commons/pool2/impl/PoolImplUtils.java | 10 +++++-----
src/test/java/org/apache/commons/pool2/Waiter.java | 2 +-
.../commons/pool2/impl/AtomicIntegerFactory.java | 10 +++++-----
19 files changed, 87 insertions(+), 87 deletions(-)
diff --git
a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
index 975ff453..ba91cd26 100644
--- a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
@@ -47,8 +47,8 @@ public abstract class BaseKeyedPooledObjectFactory<K, V>
extends BaseObject impl
* The default implementation is a no-op.
* </p>
*
- * @param key the key used when selecting the object
- * @param p a {@code PooledObject} wrapping the instance to be activated
+ * @param key The key used when selecting the object
+ * @param p A {@code PooledObject} wrapping the instance to be activated
*/
@Override
public void activateObject(final K key, final PooledObject<V> p) throws
Exception {
@@ -58,7 +58,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
+ * @param key The key used when constructing the object
* @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.
@@ -71,8 +71,8 @@ public abstract class BaseKeyedPooledObjectFactory<K, V>
extends BaseObject impl
* The default implementation is a no-op.
* </p>
*
- * @param key the key used when selecting the instance
- * @param p a {@code PooledObject} wrapping the instance to be destroyed
+ * @param key The key used when selecting the instance
+ * @param p A {@code PooledObject} wrapping the instance to be destroyed
*/
@Override
public void destroyObject(final K key, final PooledObject<V> p) throws
Exception {
@@ -91,8 +91,8 @@ public abstract class BaseKeyedPooledObjectFactory<K, V>
extends BaseObject impl
* The default implementation is a no-op.
* </p>
*
- * @param key the key used when selecting the object
- * @param p a {@code PooledObject} wrapping the instance to be passivated
+ * @param key The key used when selecting the object
+ * @param p A {@code PooledObject} wrapping the instance to be passivated
*/
@Override
public void passivateObject(final K key, final PooledObject<V> p) throws
Exception {
@@ -105,8 +105,8 @@ public abstract class BaseKeyedPooledObjectFactory<K, V>
extends BaseObject impl
* The default implementation always returns {@code true}.
* </p>
*
- * @param key the key used when selecting the object
- * @param p a {@code PooledObject} wrapping the instance to be validated
+ * @param key The key used when selecting the object
+ * @param p A {@code PooledObject} wrapping the instance to be validated
* @return always {@code true} in this default implementation
*/
@Override
@@ -118,7 +118,7 @@ public abstract class BaseKeyedPooledObjectFactory<K, V>
extends BaseObject impl
* Wraps the provided instance with an implementation of
* {@link PooledObject}.
*
- * @param value the instance to wrap, should not be null.
+ * @param value The instance to wrap, should not be null.
* @return The provided instance, wrapped by a {@link PooledObject}
*/
public abstract PooledObject<V> wrap(V value);
diff --git
a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
index a9b1f3d5..3330a4b9 100644
--- a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
@@ -100,7 +100,7 @@ public abstract class BasePooledObjectFactory<T> extends
BaseObject implements P
* Wraps the provided instance with an implementation of
* {@link PooledObject}.
*
- * @param obj the instance to wrap, should not be null.
+ * @param obj The instance to wrap, should not be null.
* @return The provided instance, wrapped by a {@link PooledObject}
*/
public abstract PooledObject<T> wrap(T obj);
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index 4e3e93cf..2d2d6ed5 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -76,7 +76,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* in the idle object pool. {@code addObject} is useful for
* "pre-loading" a pool with idle objects (Optional operation).
*
- * @param key the key a new instance should be added to
+ * @param key The key a new instance should be added to
* @throws Exception
* when {@link KeyedPooledObjectFactory#makeObject} fails.
* @throws IllegalStateException
@@ -158,7 +158,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* strictly specified (although it may be specified by implementations).
* </p>
*
- * @param key the key used to obtain the object
+ * @param key The key used to obtain the object
* @return An instance from this pool.
* @throws IllegalStateException
* after {@link #close close} has been called on this pool
@@ -185,7 +185,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* Clears the specified pool, removing all pooled instances corresponding
to
* the given {@code key} (optional operation).
*
- * @param key the key to clear
+ * @param key The key to clear
* @throws UnsupportedOperationException when this implementation doesn't
* support the operation
*
@@ -236,7 +236,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* returned to the pool corresponding to the given {@code key}.
* Returns a negative value if this information is not available.
*
- * @param key the key to query
+ * @param key The key to query
* @return The number of instances currently borrowed from but not yet
* returned to the pool corresponding to the given {@code key}.
*/
@@ -255,7 +255,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* {@code key} currently idle in this pool. Returns a negative value if
* this information is not available.
*
- * @param key the key to query
+ * @param key The key to query
* @return The number of instances corresponding to the given
* {@code key} currently idle in this pool.
*/
@@ -275,8 +275,8 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* determined (due to an exception or other problem) to be invalid.
* </p>
*
- * @param key the key used to obtain the object
- * @param obj a {@link #borrowObject borrowed} instance to be returned.
+ * @param key The key used to obtain the object
+ * @param obj A {@link #borrowObject borrowed} instance to be returned.
* @throws Exception if the instance cannot be invalidated
*/
void invalidateObject(K key, V obj) throws Exception;
@@ -296,8 +296,8 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* determined (due to an exception or other problem) to be invalid.
* </p>
*
- * @param key the key used to obtain the object
- * @param obj a {@link #borrowObject borrowed} instance to be returned.
+ * @param key The key used to obtain the object
+ * @param obj A {@link #borrowObject borrowed} instance to be returned.
* @param destroyMode destroy activation context provided to the factory
* @throws Exception if the instance cannot be invalidated
* @since 2.9.0
@@ -313,8 +313,8 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* implementation or sub-interface using a {@code key} that is
* equivalent to the one used to borrow the instance in the first place.
*
- * @param key the key used to obtain the object
- * @param obj a {@link #borrowObject borrowed} instance to be returned.
+ * @param key The key used to obtain the object
+ * @param obj A {@link #borrowObject borrowed} instance to be returned.
* @throws IllegalStateException
* if an attempt is made to return an object to the pool that
* is in any state other than allocated (i.e. borrowed).
diff --git
a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
index a596d6fe..532fe897 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
@@ -77,8 +77,8 @@ public interface KeyedPooledObjectFactory<K, V> {
/**
* Reinitializes an instance to be returned by the pool.
*
- * @param key the key used when selecting the object
- * @param p a {@code PooledObject} wrapping the instance to be activated
+ * @param key The key used when selecting the object
+ * @param p A {@code PooledObject} wrapping the instance to be activated
* @throws Exception if there is a problem activating {@code obj},
* this exception may be swallowed by the pool.
*
@@ -98,8 +98,8 @@ public interface KeyedPooledObjectFactory<K, V> {
* to the garbage collector may never be destroyed.
* </p>
*
- * @param key the key used when selecting the instance
- * @param p a {@code PooledObject} wrapping the instance to be destroyed
+ * @param key The key used when selecting the instance
+ * @param p A {@code PooledObject} wrapping the instance to be destroyed
* @throws Exception should be avoided as it may be swallowed by
* the pool implementation.
*
@@ -111,8 +111,8 @@ public interface KeyedPooledObjectFactory<K, V> {
/**
* Destroys an instance no longer needed by the pool, using the provided
{@link DestroyMode}.
*
- * @param key the key used when selecting the instance
- * @param p a {@code PooledObject} wrapping the instance to be destroyed
+ * @param key The key used when selecting the instance
+ * @param p A {@code PooledObject} wrapping the instance to be destroyed
* @param destroyMode DestroyMode providing context to the factory
* @throws Exception should be avoided as it may be swallowed by
* the pool implementation.
@@ -131,7 +131,7 @@ public interface KeyedPooledObjectFactory<K, V> {
* Creates an instance that can be served by the pool and
* wrap it in a {@link PooledObject} to be managed by the pool.
*
- * @param key the key used when constructing the object
+ * @param key The key used when constructing the object
* @return A {@code PooledObject} wrapping an instance that can
* be served by the pool.
*
@@ -143,8 +143,8 @@ public interface KeyedPooledObjectFactory<K, V> {
/**
* Uninitializes an instance to be returned to the idle object pool.
*
- * @param key the key used when selecting the object
- * @param p a {@code PooledObject} wrapping the instance to be passivated
+ * @param key The key used when selecting the object
+ * @param p A {@code PooledObject} wrapping the instance to be passivated
* @throws Exception if there is a problem passivating {@code obj},
* this exception may be swallowed by the pool.
*
@@ -155,8 +155,8 @@ public interface KeyedPooledObjectFactory<K, V> {
/**
* Ensures that the instance is safe to be returned by the pool.
*
- * @param key the key used when selecting the object
- * @param p a {@code PooledObject} wrapping the instance to be validated
+ * @param key The key used when selecting the object
+ * @param p A {@code PooledObject} wrapping the instance to be validated
* @return {@code false} if {@code obj} is not valid and should
* be dropped from the pool, {@code true} otherwise.
*/
diff --git a/src/main/java/org/apache/commons/pool2/ObjectPool.java
b/src/main/java/org/apache/commons/pool2/ObjectPool.java
index 230909b5..c43ce1ef 100644
--- a/src/main/java/org/apache/commons/pool2/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/ObjectPool.java
@@ -176,7 +176,7 @@ public interface ObjectPool<T> extends Closeable {
* determined (due to an exception or other problem) to be invalid.
* </p>
*
- * @param obj a {@link #borrowObject borrowed} instance to be disposed.
+ * @param obj A {@link #borrowObject borrowed} instance to be disposed.
* @throws Exception if the instance cannot be invalidated
*/
void invalidateObject(T obj) throws Exception;
@@ -194,7 +194,7 @@ public interface ObjectPool<T> extends Closeable {
* determined (due to an exception or other problem) to be invalid.
* </p>
*
- * @param obj a {@link #borrowObject borrowed} instance to be disposed.
+ * @param obj A {@link #borrowObject borrowed} instance to be disposed.
* @param destroyMode destroy activation context provided to the factory
* @throws Exception if the instance cannot be invalidated
* @since 2.9.0
@@ -208,7 +208,7 @@ public interface ObjectPool<T> extends Closeable {
* <strong>must</strong> have been obtained using {@link #borrowObject()}
or
* a related method as defined in an implementation or sub-interface.
*
- * @param obj a {@link #borrowObject borrowed} instance to be returned.
+ * @param obj A {@link #borrowObject borrowed} instance to be returned.
* @throws IllegalStateException
* if an attempt is made to return an object to the pool that
* is in any state other than allocated (i.e. borrowed).
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java
b/src/main/java/org/apache/commons/pool2/PooledObject.java
index 52d1aa0f..4db210df 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -37,7 +37,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 pooledObject the PooledObject to unwrap, may be null.
+ * @param pooledObject The PooledObject to unwrap, may be null.
* @return The wrapped object or null.
* @since 2.13.0
*/
@@ -48,7 +48,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
/**
* Tests whether the given PooledObject is null <em>or</em> wraps a null.
*
- * @param pooledObject the PooledObject to test, may be null.
+ * @param pooledObject The PooledObject to test, may be null.
* @return whether the given PooledObject is null <em>or</em> wraps a null.
* @since 2.12.0
*/
@@ -59,7 +59,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
/**
* Tests whether the given PooledObject isn't null <em>and</em> doesn't
wraps a null.
*
- * @param pooledObject the PooledObject to test, may be null.
+ * @param pooledObject The PooledObject to test, may be null.
* @return whether the given PooledObject isn't null <em>and</em> doesn't
wraps a null.
* @since 2.13.0
*/
@@ -347,7 +347,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
* When set to false, abandoned logs may only include caller class
information rather than method names, line
* numbers, and other normal metadata available in a full stack trace.
*
- * @param requireFullStackTrace the new configuration setting for
abandoned object logging.
+ * @param requireFullStackTrace The new configuration setting for
abandoned object logging.
* @since 2.7.0
*/
default void setRequireFullStackTrace(final boolean requireFullStackTrace)
{
diff --git a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
index ac0ab031..e7959e77 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
@@ -73,7 +73,7 @@ public interface PooledObjectFactory<T> {
/**
* Reinitializes an instance to be returned by the pool.
*
- * @param p a {@code PooledObject} wrapping the instance to be activated
+ * @param p A {@code PooledObject} wrapping the instance to be activated
* @throws Exception if there is a problem activating {@code obj},
* this exception may be swallowed by the pool.
*
@@ -94,7 +94,7 @@ public interface PooledObjectFactory<T> {
* to the garbage collector may never be destroyed.
* </p>
*
- * @param p a {@code PooledObject} wrapping the instance to be destroyed
+ * @param p A {@code PooledObject} wrapping the instance to be destroyed
* @throws Exception should be avoided as it may be swallowed by
* the pool implementation.
*
@@ -107,7 +107,7 @@ public interface PooledObjectFactory<T> {
* Destroys an instance no longer needed by the pool, using the provided
* DestroyMode.
*
- * @param p a {@code PooledObject} wrapping the instance to be destroyed
+ * @param p A {@code PooledObject} wrapping the instance to be destroyed
* @param destroyMode DestroyMode providing context to the factory
* @throws Exception should be avoided as it may be swallowed by
* the pool implementation.
@@ -135,7 +135,7 @@ public interface PooledObjectFactory<T> {
/**
* Uninitializes an instance to be returned to the idle object pool.
*
- * @param p a {@code PooledObject} wrapping the instance to be passivated
+ * @param p A {@code PooledObject} wrapping the instance to be passivated
* @throws Exception if there is a problem passivating {@code obj},
* this exception may be swallowed by the pool.
*
@@ -146,7 +146,7 @@ public interface PooledObjectFactory<T> {
/**
* Ensures that the instance is safe to be returned by the pool.
*
- * @param p a {@code PooledObject} wrapping the instance to be validated
+ * @param p A {@code PooledObject} wrapping the instance to be validated
* @return {@code false} if {@code obj} is not valid and should
* be dropped from the pool, {@code true} otherwise.
*/
diff --git a/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
b/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
index 90ab46ed..a14978ec 100644
--- a/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
@@ -41,7 +41,7 @@ public class AbandonedConfig {
/**
* Creates a new instance with values from the given instance.
*
- * @param abandonedConfig the source, may be null.
+ * @param abandonedConfig The source, may be null.
* @return A new instance or null if the input is null.
* @since 2.11.0
*/
@@ -103,7 +103,7 @@ public class AbandonedConfig {
/**
* Creates a new instance with values from the given instance.
*
- * @param abandonedConfig the source.
+ * @param abandonedConfig The source.
*/
@SuppressWarnings("resource")
private AbandonedConfig(final AbandonedConfig abandonedConfig) {
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 049f206c..3fc6b93c 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
@@ -184,7 +184,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
/**
* Sets the scheduled future.
*
- * @param scheduledFuture the scheduled future.
+ * @param scheduledFuture The scheduled future.
*/
void setScheduledFuture(final ScheduledFuture<?> scheduledFuture) {
this.scheduledFuture = scheduledFuture;
@@ -501,7 +501,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
/**
* Returns the duration since the given start time.
*
- * @param startInstant the start time
+ * @param startInstant The start time
* @return The duration since the given start time
*/
final Duration durationSince(final Instant startInstant) {
@@ -1379,7 +1379,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
/**
* Sets the abandoned object removal configuration.
*
- * @param abandonedConfig the new configuration to use. This is used by
value.
+ * @param abandonedConfig The new configuration to use. This is used by
value.
* @see AbandonedConfig
* @since 2.11.0
*/
@@ -1558,7 +1558,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* Sets the timeout that will be used when waiting for the Evictor to
shutdown if this pool is closed and it is the
* only pool still using the value for the Evictor.
*
- * @param evictorShutdownTimeout the timeout in milliseconds that will be
used while waiting for the Evictor
+ * @param evictorShutdownTimeout The timeout in milliseconds that will be
used while waiting for the Evictor
* to shut down.
* @since 2.10.0
*/
@@ -1570,7 +1570,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* Sets the timeout that will be used when waiting for the Evictor to
shutdown if this pool is closed and it is the
* only pool still using the value for the Evictor.
*
- * @param evictorShutdownTimeoutMillis the timeout in milliseconds that
will be used while waiting for the Evictor
+ * @param evictorShutdownTimeoutMillis The timeout in milliseconds that
will be used while waiting for the Evictor
* to shut down.
* @deprecated Use {@link #setEvictorShutdownTimeout(Duration)}.
*/
@@ -1617,7 +1617,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* {@link #getBlockWhenExhausted} is true. When less than 0, the
* {@code borrowObject()} method may block indefinitely.
*
- * @param maxWaitDuration the maximum duration
+ * @param maxWaitDuration The maximum duration
* {@code borrowObject()} will block or negative
* for indefinitely.
*
@@ -1636,7 +1636,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* {@link #getBlockWhenExhausted} is true. When less than 0, the
* {@code borrowObject()} method may block indefinitely.
*
- * @param maxWaitMillis the maximum number of milliseconds
+ * @param maxWaitMillis The maximum number of milliseconds
* {@code borrowObject()} will block or negative
* for indefinitely.
*
@@ -2134,7 +2134,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
/**
* Updates statistics after an object is returned to the pool.
*
- * @param activeTime the amount of time (in milliseconds) that the
returning
+ * @param activeTime The amount of time (in milliseconds) that the
returning
* object was checked out
*/
final void updateStatsReturn(final Duration activeTime) {
@@ -2149,8 +2149,8 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* Waits for notification on the given object for the specified duration.
* Duration.ZERO causes the thread to wait indefinitely.
*
- * @param obj the object to wait on
- * @param duration the duration to wait
+ * @param obj The object to wait on
+ * @param duration The duration to wait
* @throws InterruptedException if interrupted while waiting
* @throws IllegalArgumentException if the duration is negative
*/
diff --git a/src/main/java/org/apache/commons/pool2/impl/CallStack.java
b/src/main/java/org/apache/commons/pool2/impl/CallStack.java
index 24485333..76985a43 100644
--- a/src/main/java/org/apache/commons/pool2/impl/CallStack.java
+++ b/src/main/java/org/apache/commons/pool2/impl/CallStack.java
@@ -47,7 +47,7 @@ public interface CallStack {
* Prints the current stack trace if available to a PrintWriter. The
format is undefined and is primarily useful
* for debugging issues with {@link PooledObject} usage in user code.
*
- * @param writer a PrintWriter to write the current stack trace to if
available
+ * @param writer A PrintWriter to write the current stack trace to if
available
* @return true if a stack trace was available to print or false if
nothing was printed
*/
boolean printStackTrace(PrintWriter writer);
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 7035a57e..41d1cf7e 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
@@ -299,7 +299,7 @@ public class DefaultPooledObject<T> implements
PooledObject<T> {
* only include caller class information rather than method names, line
numbers,
* and other normal metadata available in a full stack trace.
*
- * @param requireFullStackTrace the new configuration setting for
abandoned object
+ * @param requireFullStackTrace The new configuration setting for
abandoned object
* logging
* @since 2.5
*/
diff --git a/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java
b/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java
index 0e9e3e90..3701011b 100644
--- a/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java
+++ b/src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java
@@ -108,7 +108,7 @@ final class EvictionTimer {
/**
* Constructs a new instance to track the given reference.
*
- * @param ref the reference to track.
+ * @param ref The reference to track.
*/
private WeakRunner(final WeakReference<R> ref) {
this.ref = ref;
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 b8ff4a49..81a6342b 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
@@ -251,7 +251,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* Constructs a new {@code GenericKeyedObjectPool} using defaults from
* {@link GenericKeyedObjectPoolConfig}.
*
- * @param factory the factory to be used to create entries
+ * @param factory The factory to be used to create entries
*/
public GenericKeyedObjectPool(final KeyedPooledObjectFactory<K, T>
factory) {
this(factory, new GenericKeyedObjectPoolConfig<>());
@@ -261,7 +261,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* Constructs a new {@code GenericKeyedObjectPool} using a specific
* configuration.
*
- * @param factory the factory to be used to create entries
+ * @param factory The factory to be used to create entries
* @param config The configuration to use for this pool instance. The
* configuration is used by value. Subsequent changes to
* the configuration object will not be reflected in the
@@ -336,7 +336,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* a {@code NullPointerException} is thrown.
* </p>
*
- * @param key the key a new instance should be added to
+ * @param key The key a new instance should be added to
* @throws Exception when {@link KeyedPooledObjectFactory#makeObject}
* fails.
*/
@@ -670,7 +670,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* instances to the most loaded keyed pools. To avoid triggering
* possible object creation, use {@link #clear(Object, boolean)}.
*
- * @param key the key to clear
+ * @param key The key to clear
*/
@Override
public void clear(final K key) {
@@ -688,7 +688,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* by this operation, adding instances to the most loaded keyed pools.
* </p>
*
- * @param key the key to clear
+ * @param key The key to clear
* @param reuseCapacity whether or not to reuse freed capacity
* @since 2.12.0
*/
@@ -1724,7 +1724,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
/**
* Sets the configuration.
*
- * @param conf the new configuration to use. This is used by value.
+ * @param conf The new configuration to use. This is used by value.
* @see GenericKeyedObjectPoolConfig
*/
public void setConfig(final GenericKeyedObjectPoolConfig<T> conf) {
@@ -1747,7 +1747,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* maxIdlePerKey for heavily loaded system will vary but the default is a
* good starting point.
*
- * @param maxIdlePerKey the maximum number of "idle" instances that can be
+ * @param maxIdlePerKey The maximum number of "idle" instances that can be
* held in a given keyed sub-pool. Use a negative
value
* for no limit
*
@@ -1762,7 +1762,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* (checked out or idle), per key. When the limit is reached, the sub-pool
* is said to be exhausted. A negative value indicates no limit.
*
- * @param maxTotalPerKey the limit on the number of active instances per
key
+ * @param maxTotalPerKey The limit on the number of active instances per
key
* @see #getMaxTotalPerKey
*/
public void setMaxTotalPerKey(final int maxTotalPerKey) {
diff --git a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
index ff9e6edf..02ba23c7 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -616,7 +616,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* is thrown.
* </p>
*
- * @param idleCount the number of idle instances desired
+ * @param idleCount The number of idle instances desired
* @param always true means create instances even if the pool has no
threads waiting
* @throws Exception if the factory's makeObject throws
*/
@@ -1100,7 +1100,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
/**
* Sets the base pool configuration.
*
- * @param conf the new configuration to use. This is used by value.
+ * @param conf The new configuration to use. This is used by value.
* @see GenericObjectPoolConfig
*/
public void setConfig(final GenericObjectPoolConfig<T> conf) {
diff --git
a/src/main/java/org/apache/commons/pool2/impl/InterruptibleReentrantLock.java
b/src/main/java/org/apache/commons/pool2/impl/InterruptibleReentrantLock.java
index 52824da9..1cd70414 100644
---
a/src/main/java/org/apache/commons/pool2/impl/InterruptibleReentrantLock.java
+++
b/src/main/java/org/apache/commons/pool2/impl/InterruptibleReentrantLock.java
@@ -46,7 +46,7 @@ final class InterruptibleReentrantLock extends ReentrantLock {
/**
* Interrupts the threads that are waiting on a specific condition.
*
- * @param condition the condition on which the threads are waiting.
+ * @param condition The condition on which the threads are waiting.
*/
void interruptWaiters(final Condition condition) {
getWaitingThreads(condition).forEach(Thread::interrupt);
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 15a23df9..056d5234 100644
--- a/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
@@ -347,7 +347,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* the given collection, added in traversal order of the
* collection's iterator.
*
- * @param c the collection of elements to initially contain
+ * @param c The collection of elements to initially contain
* @throws NullPointerException if the specified collection or any
* of its elements are null
*/
@@ -369,7 +369,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
/**
* Creates a {@code LinkedBlockingDeque} with the given (fixed) capacity.
*
- * @param capacity the capacity of this deque
+ * @param capacity The capacity of this deque
* @throws IllegalArgumentException if {@code capacity} is less than 1
*/
LinkedBlockingDeque(final int capacity) {
@@ -380,7 +380,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* Creates a {@code LinkedBlockingDeque} with the given (fixed) capacity
* and fairness policy.
*
- * @param capacity the capacity of this deque
+ * @param capacity The capacity of this deque
* @param fairness true means threads waiting on the deque should be served
* as if waiting in a FIFO request queue
* @throws IllegalArgumentException if {@code capacity} is less than 1
@@ -1089,7 +1089,7 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
/**
* Reconstitutes this deque from a stream (that is, deserialize it).
*
- * @param s the stream
+ * @param s The stream
*/
private void readObject(final ObjectInputStream s) throws IOException,
ClassNotFoundException {
s.defaultReadObject();
@@ -1495,7 +1495,7 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
*
* @serialData The capacity (int), followed by elements (each an
* {@code Object}) in the proper order, followed by a null
- * @param s the stream
+ * @param s The stream
* @throws IOException if I/O errors occur while writing to the
underlying {@code OutputStream}
*/
private void writeObject(final java.io.ObjectOutputStream s) throws
IOException {
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 41c5e7f0..a0f87118 100644
--- a/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
+++ b/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
@@ -132,7 +132,7 @@ final class PoolImplUtils {
* definition of the class
*
* @param clazz defining class
- * @param argType the type argument of interest
+ * @param argType The type argument of interest
* @return An instance of {@link Class} representing the type used by the
type parameter or an instance of
* {@link Integer} representing the index for the type in the
definition of the defining class
*/
@@ -157,7 +157,7 @@ final class PoolImplUtils {
* Returns the greater of two {@code Instant} values. That is, the result
is the argument closer to the value of
* {@link Instant#MAX}. If the arguments have the same value, the result
is that same value.
*
- * @param a an argument.
+ * @param a An argument.
* @param b another argument.
* @return The larger of {@code a} and {@code b}.
*/
@@ -169,7 +169,7 @@ final class PoolImplUtils {
* Returns the smaller of two {@code Instant} values. That is, the result
is the argument closer to the value of
* {@link Instant#MIN}. If the arguments have the same value, the result
is that same value.
*
- * @param a an argument.
+ * @param a An argument.
* @param b another argument.
* @return The smaller of {@code a} and {@code b}.
*/
@@ -219,8 +219,8 @@ final class PoolImplUtils {
/**
* Converts am amount and TimeUnit into a Duration.
*
- * @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
+ * @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.
*/
static Duration toDuration(final long amount, final TimeUnit timeUnit) {
diff --git a/src/test/java/org/apache/commons/pool2/Waiter.java
b/src/test/java/org/apache/commons/pool2/Waiter.java
index 1c07708e..3916faf4 100644
--- a/src/test/java/org/apache/commons/pool2/Waiter.java
+++ b/src/test/java/org/apache/commons/pool2/Waiter.java
@@ -38,7 +38,7 @@ public class Waiter {
* The sleep duration may be shorter than duration if we catch a {@link
InterruptedException}.
* </p>
*
- * @param millis the length of time to sleep in milliseconds.
+ * @param millis The length of time to sleep in milliseconds.
*/
public static void sleepQuietly(final long millis) {
ThreadUtils.sleepQuietly(Duration.ofMillis(millis));
diff --git
a/src/test/java/org/apache/commons/pool2/impl/AtomicIntegerFactory.java
b/src/test/java/org/apache/commons/pool2/impl/AtomicIntegerFactory.java
index ebbaeac5..102e95f7 100644
--- a/src/test/java/org/apache/commons/pool2/impl/AtomicIntegerFactory.java
+++ b/src/test/java/org/apache/commons/pool2/impl/AtomicIntegerFactory.java
@@ -61,35 +61,35 @@ public class AtomicIntegerFactory
}
/**
- * @param activateLatency the activateLatency to set
+ * @param activateLatency The activateLatency to set
*/
public void setActivateLatency(final long activateLatency) {
this.activateLatency = activateLatency;
}
/**
- * @param createLatency the createLatency to set
+ * @param createLatency The createLatency to set
*/
public void setCreateLatency(final long createLatency) {
this.createLatency = createLatency;
}
/**
- * @param destroyLatency the destroyLatency to set
+ * @param destroyLatency The destroyLatency to set
*/
public void setDestroyLatency(final long destroyLatency) {
this.destroyLatency = destroyLatency;
}
/**
- * @param passivateLatency the passivateLatency to set
+ * @param passivateLatency The passivateLatency to set
*/
public void setPassivateLatency(final long passivateLatency) {
this.passivateLatency = passivateLatency;
}
/**
- * @param validateLatency the validateLatency to set
+ * @param validateLatency The validateLatency to set
*/
public void setValidateLatency(final long validateLatency) {
this.validateLatency = validateLatency;
