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 2018/06/19 22:04:45 UTC
commons-pool git commit: Javadoc: Add missing closing HTML tags.
Repository: commons-pool
Updated Branches:
refs/heads/master cbb41d7d9 -> 2c6c451ff
Javadoc: Add missing closing HTML tags.
Project: http://git-wip-us.apache.org/repos/asf/commons-pool/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-pool/commit/2c6c451f
Tree: http://git-wip-us.apache.org/repos/asf/commons-pool/tree/2c6c451f
Diff: http://git-wip-us.apache.org/repos/asf/commons-pool/diff/2c6c451f
Branch: refs/heads/master
Commit: 2c6c451ff958ba0775fbf75cec1e685067ecd970
Parents: cbb41d7
Author: Gary Gregory <ga...@gmail.com>
Authored: Tue Jun 19 16:04:42 2018 -0600
Committer: Gary Gregory <ga...@gmail.com>
Committed: Tue Jun 19 16:04:42 2018 -0600
----------------------------------------------------------------------
.../commons/pool2/BaseKeyedPooledObjectFactory.java | 4 ++++
.../java/org/apache/commons/pool2/BaseObjectPool.java | 1 +
.../java/org/apache/commons/pool2/KeyedObjectPool.java | 11 +++++++++++
.../apache/commons/pool2/KeyedPooledObjectFactory.java | 5 +++++
src/main/java/org/apache/commons/pool2/ObjectPool.java | 9 +++++++++
src/main/java/org/apache/commons/pool2/PooledObject.java | 2 ++
.../org/apache/commons/pool2/PooledObjectFactory.java | 3 +++
.../apache/commons/pool2/impl/DefaultPooledObject.java | 1 +
8 files changed, 36 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2c6c451f/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
index 4ea9265..81cadbb 100644
--- a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
@@ -64,6 +64,7 @@ public abstract class BaseKeyedPooledObjectFactory<K,V> extends BaseObject
* Destroy an instance no longer needed by the pool.
* <p>
* The default implementation is a no-op.
+ * </p>
*
* @param key the key used when selecting the instance
* @param p a {@code PooledObject} wrapping the instance to be destroyed
@@ -78,6 +79,7 @@ public abstract class BaseKeyedPooledObjectFactory<K,V> extends BaseObject
* Ensures that the instance is safe to be returned by the pool.
* <p>
* The default implementation always returns {@code true}.
+ * </p>
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be validated
@@ -92,6 +94,7 @@ public abstract class BaseKeyedPooledObjectFactory<K,V> extends BaseObject
* Reinitialize an instance to be returned by the pool.
* <p>
* The default implementation is a no-op.
+ * </p>
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be activated
@@ -106,6 +109,7 @@ public abstract class BaseKeyedPooledObjectFactory<K,V> extends BaseObject
* Uninitialize an instance to be returned to the idle object pool.
* <p>
* The default implementation is a no-op.
+ * </p>
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be passivated
http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2c6c451f/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
index b255b5c..890071a 100644
--- a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
@@ -86,6 +86,7 @@ public abstract class BaseObjectPool<T> extends BaseObject implements ObjectPool
* <p>
* This affects the behavior of <code>isClosed</code> and
* <code>assertOpen</code>.
+ * </p>
*/
@Override
public void close() {
http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2c6c451f/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index 3761d7f..59a5141 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -23,8 +23,10 @@ import java.util.NoSuchElementException;
* A "keyed" pooling interface.
* <p>
* A keyed pool maintains a pool of instances for each key value.
+ * </p>
* <p>
* Example of use:
+ * </p>
* <pre style="border:solid thin; padding: 1ex;"
* > Object obj = <code style="color:#00C">null</code>;
* Object key = <code style="color:#C00">"Key"</code>;
@@ -48,9 +50,11 @@ import java.util.NoSuchElementException;
* one instance per key value, or may choose to maintain a pool of instances
* for each key (essentially creating a {@link java.util.Map Map} of
* {@link ObjectPool pools}).
+ * </p>
* <p>
* See {@link org.apache.commons.pool2.impl.GenericKeyedObjectPool
* GenericKeyedObjectPool} for an implementation.
+ * </p>
*
* @param <K> The type of keys maintained by this pool.
* @param <V> Type of element pooled in this pool.
@@ -71,6 +75,7 @@ public interface KeyedObjectPool<K,V> extends Closeable {
* {@link KeyedPooledObjectFactory#activateObject activateObject} and then
* (optionally) validated with
* {@link KeyedPooledObjectFactory#validateObject validateObject}.
+ * </p>
* <p>
* By contract, clients <strong>must</strong> return the borrowed object
* using {@link #returnObject returnObject},
@@ -78,9 +83,11 @@ public interface KeyedObjectPool<K,V> extends Closeable {
* defined in an implementation or sub-interface, using a <code>key</code>
* that is {@link Object#equals equivalent} to the one used to borrow the
* instance in the first place.
+ * </p>
* <p>
* The behaviour of this method when the pool has been exhausted is not
* strictly specified (although it may be specified by implementations).
+ * </p>
*
* @param key the key used to obtain the object
*
@@ -126,9 +133,11 @@ public interface KeyedObjectPool<K,V> extends Closeable {
* in an implementation or sub-interface using a <code>key</code> that is
* equivalent to the one used to borrow the <code>Object</code> in the first
* place.
+ * </p>
* <p>
* This method should be used when an object that has been borrowed is
* determined (due to an exception or other problem) to be invalid.
+ * </p>
*
* @param key the key used to obtain the object
* @param obj a {@link #borrowObject borrowed} instance to be returned.
@@ -222,8 +231,10 @@ public interface KeyedObjectPool<K,V> extends Closeable {
* Calling {@link #addObject addObject} or
* {@link #borrowObject borrowObject} after invoking this method on a pool
* will cause them to throw an {@link IllegalStateException}.
+ * </p>
* <p>
* Implementations should silently fail if not all resources can be freed.
+ * </p>
*/
@Override
void close();
http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2c6c451f/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
index c4d288d..80fea6e 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
@@ -22,6 +22,7 @@ package org.apache.commons.pool2;
* <p>
* By contract, when an {@link KeyedObjectPool}
* delegates to a {@link KeyedPooledObjectFactory},
+ * </p>
* <ol>
* <li>
* {@link #makeObject} is called whenever a new instance is needed.
@@ -63,6 +64,7 @@ package org.apache.commons.pool2;
* {@link PooledObject PooledObject<V>}. These are the object wrappers that
* pools use to track and maintain state informations about the objects that
* they manage.
+ * </p>
*
* @see KeyedObjectPool
* @see BaseKeyedPooledObjectFactory
@@ -73,6 +75,7 @@ package org.apache.commons.pool2;
* @since 2.0
*/
public interface KeyedPooledObjectFactory<K,V> {
+
/**
* Create an instance that can be served by the pool and
* wrap it in a {@link PooledObject} to be managed by the pool.
@@ -93,9 +96,11 @@ public interface KeyedPooledObjectFactory<K,V> {
* It is important for implementations of this method to be aware that there
* is no guarantee about what state <code>obj</code> will be in and the
* implementation should be prepared to handle unexpected errors.
+ * </p>
* <p>
* Also, an implementation must take in to consideration that instances lost
* to the garbage collector may never be destroyed.
+ * </p>
*
* @param key the key used when selecting the instance
* @param p a {@code PooledObject} wrapping the instance to be destroyed
http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2c6c451f/src/main/java/org/apache/commons/pool2/ObjectPool.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/ObjectPool.java b/src/main/java/org/apache/commons/pool2/ObjectPool.java
index 6aca984..b23de7a 100644
--- a/src/main/java/org/apache/commons/pool2/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/ObjectPool.java
@@ -23,6 +23,7 @@ import java.util.NoSuchElementException;
* A pooling simple interface.
* <p>
* Example of use:
+ * </p>
* <pre style="border:solid thin; padding: 1ex;"
* > Object obj = <code style="color:#00C">null</code>;
*
@@ -46,6 +47,7 @@ import java.util.NoSuchElementException;
* }</pre>
* <p>
* See {@link BaseObjectPool} for a simple base implementation.
+ * </p>
*
* @param <T> Type of element pooled in this pool.
*
@@ -65,14 +67,17 @@ public interface ObjectPool<T> extends Closeable {
* idle object and have been activated with
* {@link PooledObjectFactory#activateObject} and then validated with
* {@link PooledObjectFactory#validateObject}.
+ * </p>
* <p>
* By contract, clients <strong>must</strong> return the borrowed instance
* using {@link #returnObject}, {@link #invalidateObject}, or a related
* method as defined in an implementation or sub-interface.
+ * </p>
* <p>
* The behaviour of this method when the pool has been exhausted
* is not strictly specified (although it may be specified by
* implementations).
+ * </p>
*
* @return an instance from this pool.
*
@@ -112,9 +117,11 @@ public interface ObjectPool<T> extends Closeable {
* By contract, <code>obj</code> <strong>must</strong> have been obtained
* using {@link #borrowObject} or a related method as defined in an
* implementation or sub-interface.
+ * </p>
* <p>
* This method should be used when an object that has been borrowed is
* determined (due to an exception or other problem) to be invalid.
+ * </p>
*
* @param obj a {@link #borrowObject borrowed} instance to be disposed.
*
@@ -171,8 +178,10 @@ public interface ObjectPool<T> extends Closeable {
* <p>
* Calling {@link #addObject} or {@link #borrowObject} after invoking this
* method on a pool will cause them to throw an {@link IllegalStateException}.
+ * </p>
* <p>
* Implementations should silently fail if not all resources can be freed.
+ * </p>
*/
@Override
void close();
http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2c6c451f/src/main/java/org/apache/commons/pool2/PooledObject.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java b/src/main/java/org/apache/commons/pool2/PooledObject.java
index 9fa2872..aa8eb50 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -96,8 +96,10 @@ public interface PooledObject<T> extends Comparable<PooledObject<T>> {
*<p>
* Note: This class has a natural ordering that is inconsistent with
* equals if distinct objects have the same identity hash code.
+ * </p>
* <p>
* {@inheritDoc}
+ * </p>
*/
@Override
int compareTo(PooledObject<T> other);
http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2c6c451f/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
index 3521daa..65732da 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
@@ -22,6 +22,7 @@ package org.apache.commons.pool2;
* <p>
* By contract, when an {@link ObjectPool} delegates to a
* {@link PooledObjectFactory},
+ * </p>
* <ol>
* <li>
* {@link #makeObject} is called whenever a new instance is needed.
@@ -61,6 +62,7 @@ package org.apache.commons.pool2;
* {@link PooledObject PooledObject<V>}. These are the object wrappers that
* pools use to track and maintain state information about the objects that
* they manage.
+ * </p>
*
* @param <T> Type of element managed in this factory.
*
@@ -87,6 +89,7 @@ public interface PooledObjectFactory<T> {
* It is important for implementations of this method to be aware that there
* is no guarantee about what state <code>obj</code> will be in and the
* implementation should be prepared to handle unexpected errors.
+ * </p>
* <p>
* Also, an implementation must take in to consideration that instances lost
* to the garbage collector may never be destroyed.
http://git-wip-us.apache.org/repos/asf/commons-pool/blob/2c6c451f/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
index a3ea902..4b4c073 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
@@ -28,6 +28,7 @@ import java.util.Deque;
* the pooled objects.
* <p>
* This class is intended to be thread-safe.
+ * </p>
*
* @param <T> the type of object in the pool
*