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 04977d31 Javadoc
04977d31 is described below
commit 04977d31ce692f498861206522096e8b69ec20d3
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 17:05:38 2026 -0400
Javadoc
---
.../apache/commons/pool2/BaseKeyedPooledObjectFactory.java | 2 +-
.../org/apache/commons/pool2/BasePooledObjectFactory.java | 2 +-
src/main/java/org/apache/commons/pool2/KeyedObjectPool.java | 10 +++++-----
.../org/apache/commons/pool2/KeyedPooledObjectFactory.java | 6 +++---
src/main/java/org/apache/commons/pool2/ObjectPool.java | 8 ++++----
.../java/org/apache/commons/pool2/PooledObjectFactory.java | 6 +++---
.../org/apache/commons/pool2/impl/BaseGenericObjectPool.java | 2 +-
.../apache/commons/pool2/impl/GenericKeyedObjectPool.java | 4 ++--
.../org/apache/commons/pool2/impl/GenericObjectPool.java | 12 ++++++------
9 files changed, 26 insertions(+), 26 deletions(-)
diff --git
a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
index ba91cd26..5b971df0 100644
--- a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
@@ -60,7 +60,7 @@ public abstract class BaseKeyedPooledObjectFactory<K, V>
extends BaseObject impl
*
* @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,
+ * @throws Exception Thrown if there is a problem creating a new instance,
* this will be propagated to the code requesting an object.
*/
public abstract V create(K key) throws Exception;
diff --git
a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
index 3330a4b9..7cc0d5f5 100644
--- a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
@@ -55,7 +55,7 @@ public abstract class BasePooledObjectFactory<T> extends
BaseObject implements P
* invocation.</p>
*
* @return An instance to be served by the pool, not null.
- * @throws Exception if there is a problem creating a new instance,
+ * @throws Exception Thrown if there is a problem creating a new instance,
* this will be propagated to the code requesting an object.
*/
public abstract T create() throws Exception;
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index 2d2d6ed5..fc3ce2cc 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -177,7 +177,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* @throws UnsupportedOperationException when this implementation doesn't
* support the operation
*
- * @throws Exception if the pool cannot be cleared
+ * @throws Exception Thrown if the pool cannot be cleared
*/
void clear() throws Exception;
@@ -189,7 +189,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* @throws UnsupportedOperationException when this implementation doesn't
* support the operation
*
- * @throws Exception if the key cannot be cleared
+ * @throws Exception Thrown if the key cannot be cleared
*/
void clear(K key) throws Exception;
@@ -277,7 +277,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
*
* @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
+ * @throws Exception Thrown if the instance cannot be invalidated
*/
void invalidateObject(K key, V obj) throws Exception;
@@ -299,7 +299,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* @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
+ * @throws Exception Thrown if the instance cannot be invalidated
* @since 2.9.0
*/
default void invalidateObject(final K key, final V obj, final DestroyMode
destroyMode) throws Exception {
@@ -322,7 +322,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* to return an object that was never borrowed from the pool
* will trigger this exception.
*
- * @throws Exception if an instance cannot be returned to the pool
+ * @throws Exception Thrown if an instance cannot be returned to the pool
*/
void returnObject(K key, V obj) throws Exception;
}
diff --git
a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
index 532fe897..2abe0514 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
@@ -79,7 +79,7 @@ public interface KeyedPooledObjectFactory<K, V> {
*
* @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},
+ * @throws Exception Thrown if there is a problem activating {@code obj},
* this exception may be swallowed by the pool.
*
* @see #destroyObject
@@ -135,7 +135,7 @@ public interface KeyedPooledObjectFactory<K, V> {
* @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,
+ * @throws Exception Thrown if there is a problem creating a new instance,
* this will be propagated to the code requesting an object.
*/
PooledObject<V> makeObject(K key) throws Exception;
@@ -145,7 +145,7 @@ public interface KeyedPooledObjectFactory<K, V> {
*
* @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},
+ * @throws Exception Thrown if there is a problem passivating {@code obj},
* this exception may be swallowed by the pool.
*
* @see #destroyObject
diff --git a/src/main/java/org/apache/commons/pool2/ObjectPool.java
b/src/main/java/org/apache/commons/pool2/ObjectPool.java
index c43ce1ef..55988088 100644
--- a/src/main/java/org/apache/commons/pool2/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/ObjectPool.java
@@ -129,7 +129,7 @@ public interface ObjectPool<T> extends Closeable {
* @throws UnsupportedOperationException
* if this implementation does not support the operation
*
- * @throws Exception if the pool cannot be cleared
+ * @throws Exception Thrown if the pool cannot be cleared
*/
void clear() throws Exception;
@@ -177,7 +177,7 @@ public interface ObjectPool<T> extends Closeable {
* </p>
*
* @param obj A {@link #borrowObject borrowed} instance to be disposed.
- * @throws Exception if the instance cannot be invalidated
+ * @throws Exception Thrown if the instance cannot be invalidated
*/
void invalidateObject(T obj) throws Exception;
@@ -196,7 +196,7 @@ public interface ObjectPool<T> extends Closeable {
*
* @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
+ * @throws Exception Thrown if the instance cannot be invalidated
* @since 2.9.0
*/
default void invalidateObject(final T obj, final DestroyMode destroyMode)
throws Exception {
@@ -216,7 +216,7 @@ public interface ObjectPool<T> extends Closeable {
* to return an object that was never borrowed from the pool
* will trigger this exception.
*
- * @throws Exception if an instance cannot be returned to the pool
+ * @throws Exception Thrown if an instance cannot be returned to the pool
*/
void returnObject(T obj) throws Exception;
diff --git a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
index e7959e77..86b1b0f1 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
@@ -74,7 +74,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
- * @throws Exception if there is a problem activating {@code obj},
+ * @throws Exception Thrown if there is a problem activating {@code obj},
* this exception may be swallowed by the pool.
*
* @see #destroyObject
@@ -127,7 +127,7 @@ public interface PooledObjectFactory<T> {
* {@link PooledObject} to be managed by the pool.
*
* @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,
+ * @throws Exception Thrown if there is a problem creating a new instance,
* this will be propagated to the code requesting an object.
*/
PooledObject<T> makeObject() throws Exception;
@@ -136,7 +136,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
- * @throws Exception if there is a problem passivating {@code obj},
+ * @throws Exception Thrown if there is a problem passivating {@code obj},
* this exception may be swallowed by the pool.
*
* @see #destroyObject
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 3fc6b93c..4c90d91f 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
@@ -512,7 +512,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* Tries to ensure that the configured minimum number of idle instances are
* available in the pool.
*
- * @throws Exception if an error occurs creating idle instances
+ * @throws Exception Thrown if an error occurs creating idle instances
*/
abstract void ensureMinIdle() throws Exception;
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 81a6342b..f7c23c42 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
@@ -429,7 +429,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* @throws NoSuchElementException if a keyed object instance cannot be
* returned because the pool is exhausted.
*
- * @throws Exception if a keyed object instance cannot be returned due to
an
+ * @throws Exception Thrown if a keyed object instance cannot be returned
due to an
* error
* @since 2.12.2
*/
@@ -592,7 +592,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* @throws NoSuchElementException if a keyed object instance cannot be
* returned because the pool is exhausted.
*
- * @throws Exception if a keyed object instance cannot be returned due to
an
+ * @throws Exception Thrown if a keyed object instance cannot be returned
due to an
* error
*/
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 02ba23c7..e54aae09 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -275,7 +275,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* @param maxWaitDuration The time to wait for an object to become
available, not null.
* @return object instance from the pool
* @throws NoSuchElementException if an instance cannot be returned
- * @throws Exception if an object instance cannot be returned due to an
error
+ * @throws Exception Thrown if an object instance cannot be returned due
to an error
* @since 2.10.0
*/
public T borrowObject(final Duration maxWaitDuration) throws Exception {
@@ -407,7 +407,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* to become available
* @return object instance from the pool
* @throws NoSuchElementException if an instance cannot be returned
- * @throws Exception if an object instance cannot be returned due to an
+ * @throws Exception Thrown if an object instance cannot be returned due
to an
* error
* @deprecated Use {@link #borrowObject(Duration)}.
*/
@@ -495,7 +495,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
*
* @param maxWaitDurationRequest The time to wait for capacity to create.
* @return The new wrapped pooled object or null.
- * @throws Exception if the object factory's {@code makeObject} fails.
+ * @throws Exception Thrown if the object factory's {@code makeObject}
fails.
*/
private PooledObject<T> create(final Duration maxWaitDurationRequest)
throws Exception {
final Instant startInstant = Instant.now();
@@ -618,7 +618,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
*
* @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
+ * @throws Exception Thrown if the factory's makeObject throws
*/
private void ensureIdle(final int idleCount, final boolean always) throws
Exception {
if (idleCount < 1 || isClosed() || !always &&
!idleObjects.hasTakeWaiters()) {
@@ -901,7 +901,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* (NORMAL) {@link DestroyMode}.
* </p>
*
- * @throws Exception if an exception occurs destroying the
+ * @throws Exception Thrown if an exception occurs destroying the
* @throws IllegalStateException if obj does not belong to this pool
*/
@Override
@@ -917,7 +917,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* instance.
* </p>
*
- * @throws Exception if an exception occurs destroying the object
+ * @throws Exception Thrown if an exception occurs destroying the object
* @throws IllegalStateException if obj does not belong to this pool
* @since 2.9.0
*/
