You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2021/06/03 12:41:38 UTC
[commons-pool] branch master updated (1bcff58 -> 43e66c1)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git.
from 1bcff58 More precise Javadoc.
new 8a18468 Slightly better Javadoc; use wider line length.
new 43e66c1 Slightly better Javadoc; use wider line length.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../apache/commons/pool2/PooledObjectState.java | 28 ++++++++++------------
.../org/apache/commons/pool2/UsageTracking.java | 15 +++++-------
2 files changed, 18 insertions(+), 25 deletions(-)
[commons-pool] 01/02: Slightly better Javadoc;
use wider line length.
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
commit 8a1846885e3c31cd0389669333a308d0f23aad7f
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Jun 3 08:40:19 2021 -0400
Slightly better Javadoc; use wider line length.
---
.../apache/commons/pool2/PooledObjectState.java | 28 ++++++++++------------
1 file changed, 12 insertions(+), 16 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/PooledObjectState.java b/src/main/java/org/apache/commons/pool2/PooledObjectState.java
index d10a9f3..f09dbb8 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObjectState.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObjectState.java
@@ -17,7 +17,7 @@
package org.apache.commons.pool2;
/**
- * Provides the possible states that a {@link PooledObject} may be in.
+ * Provides all possible states of a {@link PooledObject}.
*
* @since 2.0
*/
@@ -39,12 +39,12 @@ public enum PooledObjectState {
EVICTION,
/**
- * Not in the queue, currently being tested for possible eviction. An
- * attempt to borrow the object was made while being tested which removed it
- * from the queue. It should be returned to the head of the queue once
- * eviction testing completes.
- * TODO: Consider allocating object and ignoring the result of the eviction
- * test.
+ * Not in the queue, currently being tested for possible eviction. An attempt to borrow the object was made while
+ * being tested which removed it from the queue. It should be returned to the head of the queue once eviction
+ * testing completes.
+ * <p>
+ * TODO: Consider allocating object and ignoring the result of the eviction test.
+ * </p>
*/
EVICTION_RETURN_TO_HEAD,
@@ -54,24 +54,20 @@ public enum PooledObjectState {
VALIDATION,
/**
- * Not in queue, currently being validated. The object was borrowed while
- * being validated and since testOnBorrow was configured, it was removed
- * from the queue and pre-allocated. It should be allocated once validation
- * completes.
+ * Not in queue, currently being validated. The object was borrowed while being validated and since testOnBorrow was
+ * configured, it was removed from the queue and pre-allocated. It should be allocated once validation completes.
*/
VALIDATION_PREALLOCATED,
/**
- * Not in queue, currently being validated. An attempt to borrow the object
- * was made while previously being tested for eviction which removed it from
- * the queue. It should be returned to the head of the queue once validation
+ * Not in queue, currently being validated. An attempt to borrow the object was made while previously being tested
+ * for eviction which removed it from the queue. It should be returned to the head of the queue once validation
* completes.
*/
VALIDATION_RETURN_TO_HEAD,
/**
- * Failed maintenance (e.g. eviction test or validation) and will be / has
- * been destroyed
+ * Failed maintenance (e.g. eviction test or validation) and will be / has been destroyed
*/
INVALID,
[commons-pool] 02/02: Slightly better Javadoc;
use wider line length.
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
commit 43e66c1dff71e8d4f0ef6a5e48439af3c40afb8c
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Jun 3 08:41:31 2021 -0400
Slightly better Javadoc; use wider line length.
---
src/main/java/org/apache/commons/pool2/UsageTracking.java | 15 ++++++---------
1 file changed, 6 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/UsageTracking.java b/src/main/java/org/apache/commons/pool2/UsageTracking.java
index fafcb2e..b05dacc 100644
--- a/src/main/java/org/apache/commons/pool2/UsageTracking.java
+++ b/src/main/java/org/apache/commons/pool2/UsageTracking.java
@@ -17,23 +17,20 @@
package org.apache.commons.pool2;
/**
- * This interface may be implemented by an object pool to enable clients
- * (primarily those clients that wrap pools to provide pools with extended
- * features) to provide additional information to the pool relating to object
- * using allowing more informed decisions and reporting to be made regarding
- * abandoned objects.
+ * This interface may be implemented by an object pool to enable clients (primarily those clients that wrap pools to
+ * provide pools with extended features) to provide additional information to the pool relating to object using allowing
+ * more informed decisions and reporting to be made regarding abandoned objects.
*
- * @param <T> The type of object provided by the pool.
+ * @param <T> The type of object provided by the pool.
*
* @since 2.0
*/
public interface UsageTracking<T> {
/**
- * This method is called every time a pooled object is used to enable the pool to
- * better track borrowed objects.
+ * This method is called every time a pooled object is used to enable the pool to better track borrowed objects.
*
- * @param pooledObject The object that is being used
+ * @param pooledObject The object that is being used.
*/
void use(T pooledObject);
}