This is an automated email from the ASF dual-hosted git repository.
psteitz 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 72ae930f Javadoc improvements.
72ae930f is described below
commit 72ae930fd71a40de7b4e02e9fd0cfb4a5f594e24
Author: Phil Steitz <phil.ste...@gmail.com>
AuthorDate: Thu Apr 24 17:22:39 2025 -0700
Javadoc improvements.
---
.../java/org/apache/commons/pool2/impl/GenericObjectPool.java | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
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 9794af3b..8421062a 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -221,7 +221,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
}
/**
- * Equivalent to <code>{@link #borrowObject(long)
+ * Equivalent to <code>{@link #borrowObject(Duration)
* borrowObject}({@link #getMaxWaitDuration()})</code>.
*
* {@inheritDoc}
@@ -262,7 +262,8 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* {@link #getBlockWhenExhausted()} is false). The length of time that this
* method will block when {@link #getBlockWhenExhausted()} is true is
* determined by the value passed in to the {@code maxWaitDuration}
- * parameter.
+ * parameter. Passing a negative duration will cause this method to block
+ * indefinitely until an object becomes available.
* </p>
* <p>
* When the pool is exhausted, multiple calling threads may be
@@ -392,7 +393,8 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* {@link #getBlockWhenExhausted()} is false). The length of time that this
* method will block when {@link #getBlockWhenExhausted()} is true is
* determined by the value passed in to the {@code maxWaitMillis}
- * parameter.
+ * parameter. Passing a negative duration will cause this method to block
+ * indefinitely until an object becomes available.
* </p>
* <p>
* When the pool is exhausted, multiple calling threads may be
