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 2019/08/26 22:31:38 UTC
[commons-pool] branch master updated: Close Javadoc tags.
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
The following commit(s) were added to refs/heads/master by this push:
new 8b0bbdf Close Javadoc tags.
8b0bbdf is described below
commit 8b0bbdf6165ef980132ece6a48d40a573a83282e
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Aug 26 18:31:33 2019 -0400
Close Javadoc tags.
---
.../commons/pool2/BaseKeyedPooledObjectFactory.java | 2 ++
.../java/org/apache/commons/pool2/BaseObjectPool.java | 1 +
src/main/java/org/apache/commons/pool2/PooledObject.java | 1 +
.../apache/commons/pool2/impl/DefaultEvictionPolicy.java | 2 ++
.../org/apache/commons/pool2/impl/EvictionConfig.java | 1 +
.../apache/commons/pool2/impl/GenericKeyedObjectPool.java | 5 +++++
.../org/apache/commons/pool2/impl/GenericObjectPool.java | 15 ++++++++++-----
.../commons/pool2/impl/InterruptibleReentrantLock.java | 1 +
.../apache/commons/pool2/impl/LinkedBlockingDeque.java | 4 ++++
.../commons/pool2/impl/SoftReferenceObjectPool.java | 1 +
10 files changed, 28 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
index ccf8591..2486170 100644
--- a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
@@ -21,7 +21,9 @@ package org.apache.commons.pool2;
* <p>
* All operations defined here are essentially no-op's.
* </p>
+ * <p>
* This class is immutable, and therefore thread-safe.
+ * </p>
*
* @see KeyedPooledObjectFactory
*
diff --git a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
index 890071a..331c43b 100644
--- a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
@@ -22,6 +22,7 @@ package org.apache.commons.pool2;
* indicating it is unsupported or throw {@link UnsupportedOperationException}.
* <p>
* This class is intended to be thread-safe.
+ * </p>
*
* @param <T> Type of element pooled in this pool.
*
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java b/src/main/java/org/apache/commons/pool2/PooledObject.java
index c8f66e6..142deca 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -24,6 +24,7 @@ import java.util.Deque;
* state, for the pooled objects.
* <p>
* Implementations of this class are required to be thread-safe.
+ * </p>
*
* @param <T> the type of object in the pool
*
diff --git a/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java b/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
index 075c5fe..44f75b9 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
@@ -31,7 +31,9 @@ import org.apache.commons.pool2.PooledObject;
* {@link GenericObjectPool#getSoftMinEvictableIdleTimeMillis()} /
* {@link GenericKeyedObjectPool#getSoftMinEvictableIdleTimeMillis()}
* </ul>
+ * <p>
* This class is immutable and thread-safe.
+ * </p>
*
* @param <T> the type of objects in the pool
*
diff --git a/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java b/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java
index 60d0da2..7592e53 100644
--- a/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java
@@ -22,6 +22,7 @@ package org.apache.commons.pool2.impl;
* its own specific configuration attributes.
* <p>
* This class is immutable and thread-safe.
+ * </p>
*
* @since 2.0
*/
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 7a282f1..f17ce3d 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
@@ -51,10 +51,12 @@ import org.apache.commons.pool2.SwallowedExceptionListener;
* {@link #borrowObject borrowObject} methods. Each time a new key value is
* provided to one of these methods, a sub-new pool is created under the given
* key to be managed by the containing <code>GenericKeyedObjectPool.</code>
+ * </p>
* <p>
* Note that the current implementation uses a ConcurrentHashMap which uses
* equals() to compare keys.
* This means that distinct instance keys must be distinguishable using equals.
+ * </p>
* <p>
* Optionally, one may configure the pool to examine and possibly evict objects
* as they sit idle in the pool and to ensure that a minimum number of idle
@@ -63,12 +65,15 @@ import org.apache.commons.pool2.SwallowedExceptionListener;
* configuring this optional feature. Eviction runs contend with client threads
* for access to objects in the pool, so if they run too frequently performance
* issues may result.
+ * </p>
* <p>
* Implementation note: To prevent possible deadlocks, care has been taken to
* ensure that no call to a factory method will occur within a synchronization
* block. See POOL-125 and DBCP-44 for more information.
+ * </p>
* <p>
* This class is intended to be thread-safe.
+ * </p>
*
* @see GenericObjectPool
*
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 01c57a3..5d171a4 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -40,7 +40,8 @@ import java.util.concurrent.atomic.AtomicLong;
* <p>
* When coupled with the appropriate {@link PooledObjectFactory},
* <code>GenericObjectPool</code> provides robust pooling functionality for
- * arbitrary objects.</p>
+ * arbitrary objects.
+ * </p>
* <p>
* Optionally, one may configure the pool to examine and possibly evict objects
* as they sit idle in the pool and to ensure that a minimum number of idle
@@ -48,7 +49,8 @@ import java.util.concurrent.atomic.AtomicLong;
* which runs asynchronously. Caution should be used when configuring this
* optional feature. Eviction runs contend with client threads for access to
* objects in the pool, so if they run too frequently performance issues may
- * result.</p>
+ * result.
+ * </p>
* <p>
* The pool can also be configured to detect and remove "abandoned" objects,
* i.e. objects that have been checked out of the pool but neither used nor
@@ -60,13 +62,16 @@ import java.util.concurrent.atomic.AtomicLong;
* implement the {@link TrackedUse} interface, their last use will be queried
* using the <code>getLastUsed</code> method on that interface; otherwise
* abandonment is determined by how long an object has been checked out from
- * the pool.</p>
+ * the pool.
+ * </p>
* <p>
* Implementation note: To prevent possible deadlocks, care has been taken to
* ensure that no call to a factory method will occur within a synchronization
- * block. See POOL-125 and DBCP-44 for more information.</p>
+ * block. See POOL-125 and DBCP-44 for more information.
+ * </p>
* <p>
- * This class is intended to be thread-safe.</p>
+ * This class is intended to be thread-safe.
+ * </p>
*
* @see GenericKeyedObjectPool
*
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 4509ac5..ac0120b 100644
--- a/src/main/java/org/apache/commons/pool2/impl/InterruptibleReentrantLock.java
+++ b/src/main/java/org/apache/commons/pool2/impl/InterruptibleReentrantLock.java
@@ -26,6 +26,7 @@ import java.util.concurrent.locks.ReentrantLock;
* class is intended for internal use only.
* <p>
* This class is intended to be thread-safe.
+ * </p>
*
* @since 2.0
*/
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 689e266..ccd9f65 100644
--- a/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
@@ -34,6 +34,7 @@ import java.util.concurrent.locks.Condition;
* is equal to {@link Integer#MAX_VALUE}. Linked nodes are
* dynamically created upon each insertion unless this would bring the
* deque above capacity.
+ * </p>
*
* <p>Most operations run in constant time (ignoring time spent
* blocking). Exceptions include {@link #remove(Object) remove},
@@ -41,14 +42,17 @@ import java.util.concurrent.locks.Condition;
* #removeLastOccurrence removeLastOccurrence}, {@link #contains
* contains}, {@link #iterator iterator.remove()}, and the bulk
* operations, all of which run in linear time.
+ * </p>
*
* <p>This class and its iterator implement all of the
* <em>optional</em> methods of the {@link Collection} and {@link
* Iterator} interfaces.
+ * </p>
*
* <p>This class is a member of the
* <a href="{@docRoot}/../technotes/guides/collections/index.html">
* Java Collections Framework</a>.
+ * </p>
*
* @param <E> the type of elements held in this collection
*
diff --git a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
index 91a8e74..eb841b1 100644
--- a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
@@ -32,6 +32,7 @@ import org.apache.commons.pool2.PooledObjectFactory;
* A {@link java.lang.ref.SoftReference SoftReference} based {@link ObjectPool}.
* <p>
* This class is intended to be thread-safe.
+ * </p>
*
* @param <T>
* Type of element pooled in this pool.