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 bdc9e685 Javadoc
bdc9e685 is described below
commit bdc9e685ccaf86fd59007a24131977eea7d82f63
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:09:05 2026 -0400
Javadoc
---
.../commons/pool3/BaseKeyedPooledObjectFactory.java | 2 +-
.../org/apache/commons/pool3/BaseObjectPool.java | 4 ++--
.../commons/pool3/BasePooledObjectFactory.java | 2 +-
.../org/apache/commons/pool3/KeyedObjectPool.java | 4 ++--
.../commons/pool3/KeyedPooledObjectFactory.java | 2 +-
.../java/org/apache/commons/pool3/ObjectPool.java | 2 +-
.../java/org/apache/commons/pool3/PoolUtils.java | 20 ++++++++++----------
.../apache/commons/pool3/PooledObjectFactory.java | 2 +-
.../commons/pool3/impl/BaseGenericObjectPool.java | 4 ++--
.../apache/commons/pool3/impl/CallStackUtils.java | 2 +-
.../commons/pool3/impl/GenericKeyedObjectPool.java | 2 +-
.../commons/pool3/impl/LinkedBlockingDeque.java | 4 ++--
.../org/apache/commons/pool3/impl/PoolImplUtils.java | 2 +-
.../pool3/impl/ResilientPooledObjectFactory.java | 2 +-
.../commons/pool3/impl/SoftReferenceObjectPool.java | 2 +-
.../apache/commons/pool3/proxy/CglibProxySource.java | 2 +-
.../apache/commons/pool3/proxy/JdkProxySource.java | 2 +-
17 files changed, 30 insertions(+), 30 deletions(-)
diff --git
a/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java
index 3e651d49..50c257b0 100644
--- a/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java
@@ -60,7 +60,7 @@ public abstract class BaseKeyedPooledObjectFactory<K, V, E
extends Exception> ex
* 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 E 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/pool3/BaseObjectPool.java
b/src/main/java/org/apache/commons/pool3/BaseObjectPool.java
index 252d5176..14f0a3ba 100644
--- a/src/main/java/org/apache/commons/pool3/BaseObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/BaseObjectPool.java
@@ -93,7 +93,7 @@ public abstract class BaseObjectPool<T, E extends Exception>
extends BaseObject
/**
* Not supported in this base implementation.
*
- * @return a negative value.
+ * @return A negative value.
*/
@Override
public int getNumActive() {
@@ -103,7 +103,7 @@ public abstract class BaseObjectPool<T, E extends
Exception> extends BaseObject
/**
* 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/pool3/BasePooledObjectFactory.java
b/src/main/java/org/apache/commons/pool3/BasePooledObjectFactory.java
index 55a31e71..9ef69930 100644
--- a/src/main/java/org/apache/commons/pool3/BasePooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool3/BasePooledObjectFactory.java
@@ -55,7 +55,7 @@ public abstract class BasePooledObjectFactory<T, E extends
Exception> extends Ba
* <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 E 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/pool3/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java
index da5a5400..b7480dab 100644
--- a/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java
@@ -158,7 +158,7 @@ public interface KeyedObjectPool<K, V, E extends Exception>
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 E
@@ -209,7 +209,7 @@ public interface KeyedObjectPool<K, V, E extends Exception>
extends Closeable {
/**
* 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
*/
default List<K> getKeys() {
diff --git
a/src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java
index 0924d4bc..dfbcbfda 100644
--- a/src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java
@@ -133,7 +133,7 @@ public interface KeyedPooledObjectFactory<K, V, E extends
Exception> {
* 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 E if there is a problem creating a new instance,
diff --git a/src/main/java/org/apache/commons/pool3/ObjectPool.java
b/src/main/java/org/apache/commons/pool3/ObjectPool.java
index fe2130e4..be01a134 100644
--- a/src/main/java/org/apache/commons/pool3/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/ObjectPool.java
@@ -108,7 +108,7 @@ public interface ObjectPool<T, E extends Exception> 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 E
diff --git a/src/main/java/org/apache/commons/pool3/PoolUtils.java
b/src/main/java/org/apache/commons/pool3/PoolUtils.java
index bf29b04d..7d7ad145 100644
--- a/src/main/java/org/apache/commons/pool3/PoolUtils.java
+++ b/src/main/java/org/apache/commons/pool3/PoolUtils.java
@@ -1355,7 +1355,7 @@ public final class PoolUtils {
* @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
+ * @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
@@ -1494,7 +1494,7 @@ public final class PoolUtils {
* @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
+ * @return A pool that adaptively decreases its size when idle objects are
* no longer needed.
* @see #erodingPool(KeyedObjectPool, float)
* @see #erodingPool(KeyedObjectPool, float, boolean)
@@ -1530,7 +1530,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)
*/
@@ -1573,7 +1573,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)
@@ -1607,7 +1607,7 @@ public final class PoolUtils {
* @param <E> type of exceptions from 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)
*/
@@ -1641,7 +1641,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)
*/
@@ -1674,7 +1674,7 @@ public final class PoolUtils {
* @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.
+ * @return A synchronized view of the specified KeyedPooledObjectFactory.
*/
public static <K, V, E extends Exception> KeyedPooledObjectFactory<K, V,
E> synchronizedKeyedPooledFactory(
final KeyedPooledObjectFactory<K, V, E> keyedFactory) {
@@ -1699,7 +1699,7 @@ public final class PoolUtils {
* @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.
+ * @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) {
/*
@@ -1732,7 +1732,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, E extends Exception> ObjectPool<T, E>
synchronizedPool(final ObjectPool<T, E> pool) {
if (pool == null) {
@@ -1762,7 +1762,7 @@ public final class PoolUtils {
* PooledObjectFactory.
* @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.
+ * @return A synchronized view of the specified PooledObjectFactory.
*/
public static <T, E extends Exception> PooledObjectFactory<T, E>
synchronizedPooledFactory(final PooledObjectFactory<T, E> factory) {
return new SynchronizedPooledObjectFactory<>(factory);
diff --git a/src/main/java/org/apache/commons/pool3/PooledObjectFactory.java
b/src/main/java/org/apache/commons/pool3/PooledObjectFactory.java
index 390f6b57..45cb51d4 100644
--- a/src/main/java/org/apache/commons/pool3/PooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool3/PooledObjectFactory.java
@@ -127,7 +127,7 @@ public interface PooledObjectFactory<T, E extends
Exception> {
* 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 E 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/pool3/impl/BaseGenericObjectPool.java
b/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java
index 51039293..082b6577 100644
--- a/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java
@@ -214,7 +214,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
*
* @param <T> type of objects in the {@link PooledObject}.
* @param pooledObject contains the object to wrap.
- * @return a new instance wrapping the object in the {@link
PooledObject}.
+ * @return A new instance wrapping the object in the {@link
PooledObject}.
*/
static <T> IdentityWrapper<T> unwrap(final PooledObject<T>
pooledObject) {
return new IdentityWrapper<>(pooledObject.getObject());
@@ -494,7 +494,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
*
* @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/pool3/impl/CallStackUtils.java
b/src/main/java/org/apache/commons/pool3/impl/CallStackUtils.java
index a9e1f442..9a7a6045 100644
--- a/src/main/java/org/apache/commons/pool3/impl/CallStackUtils.java
+++ b/src/main/java/org/apache/commons/pool3/impl/CallStackUtils.java
@@ -52,7 +52,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/pool3/impl/GenericKeyedObjectPool.java
b/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java
index 8cd71a69..ca346633 100644
--- a/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java
@@ -1120,7 +1120,7 @@ public class GenericKeyedObjectPool<K, T, E extends
Exception> extends BaseGener
/**
* 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/pool3/impl/LinkedBlockingDeque.java
b/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java
index 60374963..27482686 100644
--- a/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool3/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() {
@@ -1359,7 +1359,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/pool3/impl/PoolImplUtils.java
b/src/main/java/org/apache/commons/pool3/impl/PoolImplUtils.java
index d10dc456..a326b590 100644
--- a/src/main/java/org/apache/commons/pool3/impl/PoolImplUtils.java
+++ b/src/main/java/org/apache/commons/pool3/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/pool3/impl/ResilientPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool3/impl/ResilientPooledObjectFactory.java
index a93d5da6..2266f687 100644
---
a/src/main/java/org/apache/commons/pool3/impl/ResilientPooledObjectFactory.java
+++
b/src/main/java/org/apache/commons/pool3/impl/ResilientPooledObjectFactory.java
@@ -356,7 +356,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets a copy of the makeObject log.
*
- * @return a copy of the makeObject log.
+ * @return A copy of the makeObject log.
*/
public List<MakeEvent> getMakeObjectLog() {
final ArrayList<MakeEvent> makeObjectLog = new ArrayList<>();
diff --git
a/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java
b/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java
index 7dcfc940..7300b0ba 100644
--- a/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java
@@ -167,7 +167,7 @@ public class SoftReferenceObjectPool<T, E extends
Exception> extends BaseObjectP
* if invoked on a {@link #close() closed} pool
* @throws E
* 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/pool3/proxy/CglibProxySource.java
b/src/main/java/org/apache/commons/pool3/proxy/CglibProxySource.java
index d57fe479..9b703fa2 100644
--- a/src/main/java/org/apache/commons/pool3/proxy/CglibProxySource.java
+++ b/src/main/java/org/apache/commons/pool3/proxy/CglibProxySource.java
@@ -71,7 +71,7 @@ public class CglibProxySource<T> extends
AbstractProxySource<T> {
* Constructs a new builder of {@link CglibProxySource}.
*
* @param <T> type of the pooled object to be proxied.
- * @return a new builder of {@link CglibProxySource}.
+ * @return A new builder of {@link CglibProxySource}.
* @since 3.0.0
*/
public static <T> Builder<T> builder() {
diff --git a/src/main/java/org/apache/commons/pool3/proxy/JdkProxySource.java
b/src/main/java/org/apache/commons/pool3/proxy/JdkProxySource.java
index 6d2b5dbe..ddb9e7e9 100644
--- a/src/main/java/org/apache/commons/pool3/proxy/JdkProxySource.java
+++ b/src/main/java/org/apache/commons/pool3/proxy/JdkProxySource.java
@@ -80,7 +80,7 @@ public class JdkProxySource<T> extends AbstractProxySource<T>
{
* Constructs a new builder of {@link CglibProxySource}.
*
* @param <T> type of the pooled object to be proxied.
- * @return a new builder of {@link CglibProxySource}.
+ * @return A new builder of {@link CglibProxySource}.
* @since 3.0.0
*/
public static <T> Builder<T> builder() {
