This is an automated email from the ASF dual-hosted git repository.
ggregory 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 269ed251 No need for blank Javadoc lines between Javadoc @ tags
269ed251 is described below
commit 269ed251009aba6d7b0e794241798fc69f7e3d3b
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Nov 28 11:02:00 2024 -0500
No need for blank Javadoc lines between Javadoc @ tags
---
.../commons/pool2/BaseKeyedPooledObjectFactory.java | 3 ---
.../org/apache/commons/pool2/BaseObjectPool.java | 2 --
.../commons/pool2/BasePooledObjectFactory.java | 5 -----
.../org/apache/commons/pool2/KeyedObjectPool.java | 7 -------
.../commons/pool2/KeyedPooledObjectFactory.java | 8 --------
.../java/org/apache/commons/pool2/ObjectPool.java | 4 ----
.../java/org/apache/commons/pool2/PoolUtils.java | 12 ------------
.../apache/commons/pool2/PooledObjectFactory.java | 7 -------
.../java/org/apache/commons/pool2/UsageTracking.java | 1 -
.../commons/pool2/impl/BaseGenericObjectPool.java | 9 ---------
.../commons/pool2/impl/BaseObjectPoolConfig.java | 2 --
.../commons/pool2/impl/DefaultEvictionPolicy.java | 1 -
.../commons/pool2/impl/DefaultPooledObject.java | 1 -
.../pool2/impl/DefaultPooledObjectInfoMBean.java | 2 --
.../commons/pool2/impl/GenericKeyedObjectPool.java | 19 -------------------
.../commons/pool2/impl/LinkedBlockingDeque.java | 20 --------------------
.../org/apache/commons/pool2/impl/PoolImplUtils.java | 3 ---
.../commons/pool2/impl/SoftReferenceObjectPool.java | 1 -
.../apache/commons/pool2/proxy/BaseProxyHandler.java | 1 -
.../commons/pool2/proxy/CglibProxyHandler.java | 1 -
.../apache/commons/pool2/proxy/CglibProxySource.java | 1 -
.../apache/commons/pool2/proxy/JdkProxyHandler.java | 1 -
.../apache/commons/pool2/proxy/JdkProxySource.java | 1 -
.../commons/pool2/proxy/ProxiedKeyedObjectPool.java | 1 -
.../commons/pool2/proxy/ProxiedObjectPool.java | 1 -
.../org/apache/commons/pool2/proxy/ProxySource.java | 2 --
.../commons/pool2/AbstractTestKeyedObjectPool.java | 2 --
.../apache/commons/pool2/AbstractTestObjectPool.java | 1 -
.../org/apache/commons/pool2/TestBaseObjectPool.java | 2 --
29 files changed, 121 deletions(-)
diff --git
a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
index 7b45f76e..517414e3 100644
--- a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
@@ -28,10 +28,8 @@ import java.util.Objects;
* </p>
*
* @see KeyedPooledObjectFactory
- *
* @param <K> The type of keys managed by this factory.
* @param <V> Type of element managed by this factory.
- *
* @since 2.0
*/
public abstract class BaseKeyedPooledObjectFactory<K, V> extends BaseObject
implements KeyedPooledObjectFactory<K, V> {
@@ -55,7 +53,6 @@ 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,
* this will be propagated to the code requesting an object.
*/
diff --git a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
index 613085c9..a676bf31 100644
--- a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
@@ -25,7 +25,6 @@ package org.apache.commons.pool2;
* </p>
*
* @param <T> Type of element pooled in this pool.
- *
* @since 2.0
*/
public abstract class BaseObjectPool<T> extends BaseObject implements
ObjectPool<T> {
@@ -49,7 +48,6 @@ public abstract class BaseObjectPool<T> extends BaseObject
implements ObjectPool
* closed.
*
* @throws IllegalStateException when this pool has been closed.
- *
* @see #isClosed()
*/
protected final void assertOpen() throws IllegalStateException {
diff --git
a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
index b4665cea..b39a36a8 100644
--- a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
@@ -26,10 +26,8 @@ import java.util.Objects;
* This class is immutable, and therefore thread-safe
*
* @param <T> Type of element managed in this factory.
- *
* @see PooledObjectFactory
* @see BaseKeyedPooledObjectFactory
- *
* @since 2.0
*/
public abstract class BasePooledObjectFactory<T> extends BaseObject implements
PooledObjectFactory<T> {
@@ -50,7 +48,6 @@ 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,
* this will be propagated to the code requesting an object.
*/
@@ -85,7 +82,6 @@ public abstract class BasePooledObjectFactory<T> extends
BaseObject implements P
* Always returns {@code true}.
*
* @param p ignored
- *
* @return {@code true}
*/
@Override
@@ -98,7 +94,6 @@ public abstract class BasePooledObjectFactory<T> extends
BaseObject implements P
* {@link PooledObject}.
*
* @param obj the instance to wrap, should not be null.
- *
* @return The provided instance, wrapped by a {@link PooledObject}
*/
public abstract PooledObject<T> wrap(T obj);
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index dfb6a4d9..a3b7c1e8 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -66,7 +66,6 @@ import java.util.NoSuchElementException;
* @see KeyedPooledObjectFactory
* @see ObjectPool
* @see org.apache.commons.pool2.impl.GenericKeyedObjectPool
GenericKeyedObjectPool
- *
* @since 2.0
*/
public interface KeyedObjectPool<K, V> extends Closeable {
@@ -78,7 +77,6 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* "pre-loading" a pool with idle objects (Optional operation).
*
* @param key the key a new instance should be added to
- *
* @throws Exception
* when {@link KeyedPooledObjectFactory#makeObject} fails.
* @throws IllegalStateException
@@ -161,7 +159,6 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* </p>
*
* @param key the key used to obtain the object
- *
* @return an instance from this pool.
*
* @throws IllegalStateException
@@ -190,7 +187,6 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* the given {@code key} (optional operation).
*
* @param key the key to clear
- *
* @throws UnsupportedOperationException when this implementation doesn't
* support the operation
*
@@ -280,7 +276,6 @@ 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
*/
void invalidateObject(K key, V obj) throws Exception;
@@ -303,7 +298,6 @@ 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
* @since 2.9.0
*/
@@ -320,7 +314,6 @@ 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 IllegalStateException
* if an attempt is made to return an object to the pool that
* is in any state other than allocated (i.e. borrowed).
diff --git
a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
index 7139547f..853ffa68 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
@@ -68,10 +68,8 @@ package org.apache.commons.pool2;
*
* @see KeyedObjectPool
* @see BaseKeyedPooledObjectFactory
- *
* @param <K> The type of keys managed by this factory.
* @param <V> Type of element managed by this factory.
- *
* @since 2.0
*/
public interface KeyedPooledObjectFactory<K, V> {
@@ -81,7 +79,6 @@ 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},
* this exception may be swallowed by the pool.
*
@@ -103,7 +100,6 @@ public interface KeyedPooledObjectFactory<K, V> {
*
* @param key the key used when selecting the instance
* @param p a {@code PooledObject} wrapping the instance to be destroyed
- *
* @throws Exception should be avoided as it may be swallowed by
* the pool implementation.
*
@@ -118,7 +114,6 @@ public interface KeyedPooledObjectFactory<K, V> {
* @param key the key used when selecting the instance
* @param p a {@code PooledObject} wrapping the instance to be destroyed
* @param destroyMode DestroyMode providing context to the factory
- *
* @throws Exception should be avoided as it may be swallowed by
* the pool implementation.
*
@@ -137,7 +132,6 @@ public interface KeyedPooledObjectFactory<K, V> {
* wrap it in a {@link PooledObject} to be managed by the pool.
*
* @param key the key used when constructing the object
- *
* @return a {@code PooledObject} wrapping an instance that can
* be served by the pool.
*
@@ -151,7 +145,6 @@ 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},
* this exception may be swallowed by the pool.
*
@@ -164,7 +157,6 @@ public interface KeyedPooledObjectFactory<K, V> {
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be validated
- *
* @return {@code false} if {@code obj} is not valid and should
* be dropped from the pool, {@code true} otherwise.
*/
diff --git a/src/main/java/org/apache/commons/pool2/ObjectPool.java
b/src/main/java/org/apache/commons/pool2/ObjectPool.java
index 146c838d..c1e76c02 100644
--- a/src/main/java/org/apache/commons/pool2/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/ObjectPool.java
@@ -55,7 +55,6 @@ import java.util.NoSuchElementException;
* @see PooledObjectFactory
* @see KeyedObjectPool
* @see BaseObjectPool
- *
* @since 2.0
*/
public interface ObjectPool<T> extends Closeable {
@@ -111,7 +110,6 @@ public interface ObjectPool<T> extends Closeable {
* </p>
*
* @return an instance from this pool.
- *
* @throws IllegalStateException
* after {@link #close close} has been called on this pool.
* @throws Exception
@@ -177,7 +175,6 @@ 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
*/
void invalidateObject(T obj) throws Exception;
@@ -210,7 +207,6 @@ public interface ObjectPool<T> extends Closeable {
* a related method as defined in an implementation or sub-interface.
*
* @param obj a {@link #borrowObject borrowed} instance to be returned.
- *
* @throws IllegalStateException
* if an attempt is made to return an object to the pool that
* is in any state other than allocated (i.e. borrowed).
diff --git a/src/main/java/org/apache/commons/pool2/PoolUtils.java
b/src/main/java/org/apache/commons/pool2/PoolUtils.java
index daa7dd2e..18db8387 100644
--- a/src/main/java/org/apache/commons/pool2/PoolUtils.java
+++ b/src/main/java/org/apache/commons/pool2/PoolUtils.java
@@ -1333,7 +1333,6 @@ public final class PoolUtils {
* keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.
* @param <K> the type of the pool key
* @param <V> the type of pool entries
- *
* @return a {@link Map} of key and {@link TimerTask} pairs that will
* periodically check the pools idle object count.
* @throws IllegalArgumentException
@@ -1373,7 +1372,6 @@ public final class PoolUtils {
* keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.
* @param <K> the type of the pool key
* @param <V> the type of pool entries
- *
* @return the {@link TimerTask} that will periodically check the pools
idle
* object count.
* @throws IllegalArgumentException
@@ -1414,7 +1412,6 @@ public final class PoolUtils {
* the frequency in milliseconds to check the number of idle
objects in a pool,
* see {@link Timer#schedule(TimerTask, long, long)}.
* @param <T> the type of objects in the pool
- *
* @return the {@link TimerTask} that will periodically check the pools
idle
* object count.
* @throws IllegalArgumentException
@@ -1471,7 +1468,6 @@ public final class PoolUtils {
* count when possible.
* @param <K> the type of the pool key
* @param <V> the type of pool entries
- *
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null}.
* @return a pool that adaptively decreases its size when idle objects are
@@ -1506,7 +1502,6 @@ public final class PoolUtils {
* shrinks less aggressively.
* @param <K> the type of the pool key
* @param <V> the type of pool entries
- *
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null} or when {@code
factor}
* is not positive.
@@ -1549,7 +1544,6 @@ public final class PoolUtils {
* when true, each key is treated independently.
* @param <K> the type of the pool key
* @param <V> the type of pool entries
- *
* @throws IllegalArgumentException
* when {@code keyedPool} is {@code null} or when {@code
factor}
* is not positive.
@@ -1584,7 +1578,6 @@ public final class PoolUtils {
* the ObjectPool to be decorated so it shrinks its idle count
* when possible.
* @param <T> the type of objects in the pool
- *
* @throws IllegalArgumentException
* when {@code pool} is {@code null}.
* @return a pool that adaptively decreases its size when idle objects are
@@ -1617,7 +1610,6 @@ public final class PoolUtils {
* shrinks more aggressively. If 1 < factor then the pool
* shrinks less aggressively.
* @param <T> the type of objects in the pool
- *
* @throws IllegalArgumentException
* when {@code pool} is {@code null} or when {@code factor} is
* not positive.
@@ -1658,7 +1650,6 @@ public final class PoolUtils {
* the number of idle objects to add for each {@code key}.
* @param <K> the type of the pool key
* @param <V> the type of pool entries
- *
* @throws Exception
* when {@link KeyedObjectPool#addObject(Object)} fails.
* @throws IllegalArgumentException
@@ -1689,7 +1680,6 @@ public final class PoolUtils {
* the number of idle objects to add for {@code key}.
* @param <K> the type of the pool key
* @param <V> the type of pool entries
- *
* @throws Exception
* when {@link KeyedObjectPool#addObject(Object)} fails.
* @throws IllegalArgumentException
@@ -1715,7 +1705,6 @@ public final class PoolUtils {
* @param count
* the number of idle objects to add.
* @param <T> the type of objects in the pool
- *
* @throws Exception
* when {@link ObjectPool#addObject()} fails.
* @throws IllegalArgumentException
@@ -1764,7 +1753,6 @@ public final class PoolUtils {
* KeyedObjectPool.
* @param <K> the type of the pool key
* @param <V> the type of pool entries
- *
* @return a synchronized view of the specified KeyedObjectPool.
*/
public static <K, V> KeyedObjectPool<K, V> synchronizedPool(final
KeyedObjectPool<K, V> keyedPool) {
diff --git a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
index 4f57bf1a..deb93902 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
@@ -65,7 +65,6 @@ package org.apache.commons.pool2;
* </p>
*
* @param <T> Type of element managed in this factory.
- *
* @see ObjectPool
*
* @since 2.0
@@ -76,7 +75,6 @@ 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},
* this exception may be swallowed by the pool.
*
@@ -98,7 +96,6 @@ public interface PooledObjectFactory<T> {
* </p>
*
* @param p a {@code PooledObject} wrapping the instance to be destroyed
- *
* @throws Exception should be avoided as it may be swallowed by
* the pool implementation.
*
@@ -113,7 +110,6 @@ public interface PooledObjectFactory<T> {
*
* @param p a {@code PooledObject} wrapping the instance to be destroyed
* @param destroyMode DestroyMode providing context to the factory
- *
* @throws Exception should be avoided as it may be swallowed by
* the pool implementation.
*
@@ -132,7 +128,6 @@ 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,
* this will be propagated to the code requesting an object.
*/
@@ -142,7 +137,6 @@ 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},
* this exception may be swallowed by the pool.
*
@@ -154,7 +148,6 @@ public interface PooledObjectFactory<T> {
* Ensures that the instance is safe to be returned by the pool.
*
* @param p a {@code PooledObject} wrapping the instance to be validated
- *
* @return {@code false} if {@code obj} is not valid and should
* be dropped from the pool, {@code true} otherwise.
*/
diff --git a/src/main/java/org/apache/commons/pool2/UsageTracking.java
b/src/main/java/org/apache/commons/pool2/UsageTracking.java
index 48bdb2f5..836fed47 100644
--- a/src/main/java/org/apache/commons/pool2/UsageTracking.java
+++ b/src/main/java/org/apache/commons/pool2/UsageTracking.java
@@ -22,7 +22,6 @@ package org.apache.commons.pool2;
* more informed decisions and reporting to be made regarding abandoned
objects.
*
* @param <T> The type of object provided by the pool.
- *
* @since 2.0
*/
public interface UsageTracking<T> {
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 99660ac2..35d32e14 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
@@ -579,7 +579,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* will be run.
*
* @return number of milliseconds to sleep between evictor runs
- *
* @see #setTimeBetweenEvictionRuns
* @since 2.11.0
*/
@@ -603,7 +602,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* used by this pool.
*
* @return The fully qualified class name of the {@link EvictionPolicy}
- *
* @see #setEvictionPolicyClassName(String)
*/
public final String getEvictionPolicyClassName() {
@@ -935,7 +933,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* tested per run.
*
* @return max number of objects to examine during each evictor run
- *
* @see #setNumTestsPerEvictionRun
* @see #setTimeBetweenEvictionRunsMillis
*/
@@ -1149,7 +1146,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* being returned from the {@code borrowObject()} method
*
* @see #setTestOnCreate
- *
* @since 2.2
*/
public final boolean getTestOnCreate() {
@@ -1181,7 +1177,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* the pool and destroyed.
*
* @return {@code true} if objects will be validated by the evictor
- *
* @see #setTestWhileIdle
* @see #setTimeBetweenEvictionRunsMillis
*/
@@ -1195,7 +1190,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* will be run.
*
* @return number of milliseconds to sleep between evictor runs
- *
* @see #setTimeBetweenEvictionRuns
* @since 2.10.0
* @deprecated {@link #getDurationBetweenEvictionRuns()}.
@@ -1211,7 +1205,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* will be run.
*
* @return number of milliseconds to sleep between evictor runs
- *
* @see #setTimeBetweenEvictionRunsMillis
* @deprecated Use {@link #getDurationBetweenEvictionRuns()}.
*/
@@ -1332,7 +1325,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* Sets the abandoned object removal configuration.
*
* @param abandonedConfig the new configuration to use. This is used by
value.
- *
* @see AbandonedConfig
* @since 2.11.0
*/
@@ -1832,7 +1824,6 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject implements Aut
* {@code borrowObject()} method
*
* @see #getTestOnCreate
- *
* @since 2.2
*/
public final void setTestOnCreate(final boolean testOnCreate) {
diff --git
a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
index 1293848f..0ca81c36 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
@@ -159,7 +159,6 @@ public abstract class BaseObjectPoolConfig<T> extends
BaseObject implements Clon
*
* @see GenericObjectPool#getTestOnCreate()
* @see GenericKeyedObjectPool#getTestOnCreate()
- *
* @since 2.2
*/
public static final boolean DEFAULT_TEST_ON_CREATE = false;
@@ -420,7 +419,6 @@ public abstract class BaseObjectPoolConfig<T> extends
BaseObject implements Clon
* Gets the value for the {@code lifo} configuration attribute for pools
created with this configuration instance.
*
* @return The current setting of {@code lifo} for this configuration
instance
- *
* @see GenericObjectPool#getLifo()
* @see GenericKeyedObjectPool#getLifo()
*/
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 06a2eb8d..8942b9dd 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultEvictionPolicy.java
@@ -38,7 +38,6 @@ import org.apache.commons.pool2.PooledObject;
* </p>
*
* @param <T> the type of objects in the pool.
- *
* @since 2.0
*/
public class DefaultEvictionPolicy<T> implements EvictionPolicy<T> {
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 c809e6c6..9de063d6 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
@@ -34,7 +34,6 @@ import org.apache.commons.pool2.TrackedUse;
* </p>
*
* @param <T> the type of object in the pool
- *
* @since 2.0
*/
public class DefaultPooledObject<T> implements PooledObject<T> {
diff --git
a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.java
b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.java
index 758843e5..70a56863 100644
---
a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.java
+++
b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.java
@@ -90,7 +90,6 @@ public interface DefaultPooledObjectInfoMBean {
* Gets a String form of the wrapper for debug purposes. The format is not
fixed and may change at any time.
*
* @return A string representation of the pooled object.
- *
* @see Object#toString()
*/
String getPooledObjectToString();
@@ -99,7 +98,6 @@ public interface DefaultPooledObjectInfoMBean {
* Gets the name of the class of the pooled object.
*
* @return The pooled object's class name.
- *
* @see Class#getName()
*/
String getPooledObjectType();
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 cbdf7a61..10472de6 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
@@ -83,10 +83,8 @@ import org.apache.commons.pool2.UsageTracking;
* </p>
*
* @see GenericObjectPool
- *
* @param <K> The type of keys maintained by this pool.
* @param <T> Type of element pooled in this pool.
- *
* @since 2.0
*/
public class GenericKeyedObjectPool<K, T> extends BaseGenericObjectPool<T>
@@ -297,7 +295,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
*
* @param key The key to associate with the idle object
* @param p The wrapped object to add.
- *
* @throws Exception If the associated factory fails to passivate the
object
*/
private void addIdleObject(final K key, final PooledObject<T> p) throws
Exception {
@@ -327,7 +324,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* </p>
*
* @param key the key a new instance should be added to
- *
* @throws Exception when {@link KeyedPooledObjectFactory#makeObject}
* fails.
*/
@@ -408,7 +404,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* to become available
*
* @return object instance from the keyed pool
- *
* @throws NoSuchElementException if a keyed object instance cannot be
* returned because the pool is exhausted.
*
@@ -518,7 +513,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* on the maximum number of objects either per key or totally.
*
* @param objectDeque The set of objects to check
- *
* @return The number of new objects to create
*/
private int calculateDeficit(final ObjectDeque<T> objectDeque) {
@@ -715,7 +709,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* Creates a new pooled object or null.
*
* @param key Key associated with new pooled object.
- *
* @return The new, wrapped pooled object. May return null.
*
* @throws Exception If the objection creation fails.
@@ -870,7 +863,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* @param always Should the object be destroyed even if it is not currently
* in the set of idle objects for the given key
* @param destroyMode DestroyMode context provided to the factory
- *
* @return {@code true} if the object was destroyed, otherwise {@code
false}
* @throws Exception If the object destruction failed
*/
@@ -933,7 +925,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* </p>
*
* @param key The key to check for idle objects
- *
* @throws Exception If a new object is required and cannot be created
*/
private void ensureMinIdle(final K key) throws Exception {
@@ -1156,7 +1147,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* is said to be exhausted. A negative value indicates no limit.
*
* @return the limit on the number of active instances per key
- *
* @see #setMaxTotalPerKey
*/
@Override
@@ -1178,7 +1168,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* </p>
*
* @return minimum size of the each keyed pool
- *
* @see #setTimeBetweenEvictionRunsMillis
*/
@Override
@@ -1298,7 +1287,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
*
* @param key pool key
* @param obj instance to invalidate
- *
* @throws Exception if an exception occurs destroying the
* object
* @throws IllegalStateException if obj does not belong to the pool
@@ -1319,7 +1307,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* @param key pool key
* @param obj instance to invalidate
* @param destroyMode DestroyMode context provided to factory
- *
* @throws Exception if an exception occurs destroying the
* object
* @throws IllegalStateException if obj does not belong to the pool
@@ -1364,7 +1351,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* {@link #getMinIdlePerKey()} idle instances are created.
*
* @param key The key to register for pool control.
- *
* @throws Exception If the associated factory throws an exception
*/
public void preparePool(final K key) throws Exception {
@@ -1382,7 +1368,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* </p>
*
* @param k The key to register
- *
* @return The objects currently associated with the given key. If this
* method returns without throwing an exception then it will never
* return null.
@@ -1469,7 +1454,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
*
* @param key pool key
* @param obj instance to return to the keyed pool
- *
* @throws IllegalStateException if an object is returned to the pool that
* was not borrowed from it or if an object
is
* returned to the pool multiple times
@@ -1615,7 +1599,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* Sets the configuration.
*
* @param conf the new configuration to use. This is used by value.
- *
* @see GenericKeyedObjectPoolConfig
*/
public void setConfig(final GenericKeyedObjectPoolConfig<T> conf) {
@@ -1652,7 +1635,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* is said to be exhausted. A negative value indicates no limit.
*
* @param maxTotalPerKey the limit on the number of active instances per
key
- *
* @see #getMaxTotalPerKey
*/
public void setMaxTotalPerKey(final int maxTotalPerKey) {
@@ -1673,7 +1655,6 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* </p>
*
* @param minIdlePerKey The minimum size of the each keyed pool
- *
* @see #getMinIdlePerKey()
* @see #getMaxIdlePerKey()
* @see #setDurationBetweenEvictionRuns(Duration)
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 66ff0f2f..599a6ec1 100644
--- a/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
@@ -173,7 +173,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* iterator.
*
* @param n given node
- *
* @return next node
*/
abstract Node<E> nextNode(Node<E> n);
@@ -475,7 +474,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* Drains the queue to the specified collection.
*
* @param c The collection to add the elements to
- *
* @return number of elements added to the collection
*
* @throws UnsupportedOperationException if the add operation is not
@@ -496,7 +494,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param collection collection to add the elements to
* @param maxElements maximum number of elements to remove from the queue
- *
* @return number of elements added to the collection
* @throws UnsupportedOperationException if the add operation is not
* supported by the specified collection
@@ -627,7 +624,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* Links provided element as first element, or returns false if full.
*
* @param e The element to link as the first element.
- *
* @return {@code true} if successful, otherwise {@code false}
*/
private boolean linkFirst(final E e) {
@@ -652,7 +648,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* Links provided element as last element, or returns false if full.
*
* @param e The element to link as the last element.
- *
* @return {@code true} if successful, otherwise {@code false}
*/
private boolean linkLast(final E e) {
@@ -689,7 +684,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param e element to link
* @param timeout length of time to wait
- *
* @return {@code true} if successful, otherwise {@code false}
*
* @throws NullPointerException if e is null
@@ -709,7 +703,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* @param e element to link
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- *
* @return {@code true} if successful, otherwise {@code false}
*
* @throws NullPointerException if e is null
@@ -740,7 +733,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param e element to link
* @param timeout length of time to wait
- *
* @return {@code true} if successful, otherwise {@code false}
*
* @throws NullPointerException if e is null
@@ -771,7 +763,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* @param e element to link
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- *
* @return {@code true} if successful, otherwise {@code false}
*
* @throws NullPointerException if e is null
@@ -802,7 +793,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param e element to link
* @param timeout length of time to wait
- *
* @return {@code true} if successful, otherwise {@code false}
*
* @throws NullPointerException if e is null
@@ -833,7 +823,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* @param e element to link
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- *
* @return {@code true} if successful, otherwise {@code false}
*
* @throws NullPointerException if e is null
@@ -883,7 +872,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* <p>This method is equivalent to {@link #pollFirst(long, TimeUnit)}.
*
* @param timeout length of time to wait
- *
* @return the unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@@ -899,7 +887,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- *
* @return the unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@@ -922,7 +909,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* to do so if the queue is empty.
*
* @param timeout length of time to wait
- *
* @return the unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@@ -949,7 +935,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- *
* @return the unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@@ -972,7 +957,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* to do so if the queue is empty.
*
* @param timeout length of time to wait
- *
* @return the unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@@ -1000,7 +984,6 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- *
* @return the unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@@ -1034,7 +1017,6 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
* </p>
*
* @param e element to link
- *
* @throws NullPointerException if e is null
* @throws InterruptedException if the thread is interrupted whilst waiting
* for space
@@ -1048,7 +1030,6 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
* is space to do so if the queue is full.
*
* @param e element to link
- *
* @throws NullPointerException if e is null
* @throws InterruptedException if the thread is interrupted whilst waiting
* for space
@@ -1070,7 +1051,6 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
* is space to do so if the queue is full.
*
* @param e element to link
- *
* @throws NullPointerException if e is null
* @throws InterruptedException if the thread is interrupted whilst waiting
* for space
diff --git a/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
b/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
index bc059e17..70deb433 100644
--- a/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
+++ b/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
@@ -38,7 +38,6 @@ final class PoolImplUtils {
* Identifies the concrete type of object that an object factory creates.
*
* @param factoryClass The factory to examine
- *
* @return the type of object the factory creates
*/
@SuppressWarnings("rawtypes")
@@ -73,7 +72,6 @@ final class PoolImplUtils {
* @param type The interface that defines a generic type
* @param clazz The class that implements the interface with a concrete
type
* @param <T> The interface type
- *
* @return concrete type used by the implementation
*/
private static <T> Object getGenericType(final Class<T> type, final
Class<? extends T> clazz) {
@@ -135,7 +133,6 @@ final class PoolImplUtils {
*
* @param clazz defining class
* @param argType the type argument of interest
- *
* @return An instance of {@link Class} representing the type used by the
type parameter or an instance of
* {@link Integer} representing the index for the type in the
definition of the defining class
*/
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 288440f6..17e7c085 100644
--- a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
@@ -266,7 +266,6 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
* references pools.
*
* @param toDestroy PooledSoftReference to destroy
- *
* @throws Exception If an error occurs while trying to destroy the object
*/
private void destroy(final PooledSoftReference<T> toDestroy) throws
Exception {
diff --git a/src/main/java/org/apache/commons/pool2/proxy/BaseProxyHandler.java
b/src/main/java/org/apache/commons/pool2/proxy/BaseProxyHandler.java
index 8a1d3573..2a63b32e 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/BaseProxyHandler.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/BaseProxyHandler.java
@@ -25,7 +25,6 @@ import org.apache.commons.pool2.UsageTracking;
* {@link ProxiedObjectPool}.
*
* @param <T> type of the wrapped pooled object
- *
* @since 2.0
*/
class BaseProxyHandler<T> {
diff --git
a/src/main/java/org/apache/commons/pool2/proxy/CglibProxyHandler.java
b/src/main/java/org/apache/commons/pool2/proxy/CglibProxyHandler.java
index 654aaeb5..bdeb4924 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/CglibProxyHandler.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/CglibProxyHandler.java
@@ -30,7 +30,6 @@ import net.sf.cglib.proxy.MethodProxy;
* </p>
*
* @param <T> type of the wrapped pooled object
- *
* @since 2.0
*/
final class CglibProxyHandler<T> extends BaseProxyHandler<T>
diff --git a/src/main/java/org/apache/commons/pool2/proxy/CglibProxySource.java
b/src/main/java/org/apache/commons/pool2/proxy/CglibProxySource.java
index ee6ef727..141b419a 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/CglibProxySource.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/CglibProxySource.java
@@ -28,7 +28,6 @@ import net.sf.cglib.proxy.Factory;
* </p>
*
* @param <T> type of the pooled object to be proxied
- *
* @since 2.0
*/
public class CglibProxySource<T> implements ProxySource<T> {
diff --git a/src/main/java/org/apache/commons/pool2/proxy/JdkProxyHandler.java
b/src/main/java/org/apache/commons/pool2/proxy/JdkProxyHandler.java
index 61e3d2b7..819ce296 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/JdkProxyHandler.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/JdkProxyHandler.java
@@ -25,7 +25,6 @@ import org.apache.commons.pool2.UsageTracking;
* Java reflection implementation of the proxy handler.
*
* @param <T> type of the wrapped pooled object
- *
* @since 2.0
*/
final class JdkProxyHandler<T> extends BaseProxyHandler<T>
diff --git a/src/main/java/org/apache/commons/pool2/proxy/JdkProxySource.java
b/src/main/java/org/apache/commons/pool2/proxy/JdkProxySource.java
index 32c57ae6..191b24dc 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/JdkProxySource.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/JdkProxySource.java
@@ -25,7 +25,6 @@ import org.apache.commons.pool2.UsageTracking;
* Provides proxy objects using Java reflection.
*
* @param <T> type of the pooled object to be proxied
- *
* @since 2.0
*/
public class JdkProxySource<T> implements ProxySource<T> {
diff --git
a/src/main/java/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.java
index cc30630b..9724b08b 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.java
@@ -29,7 +29,6 @@ import org.apache.commons.pool2.UsageTracking;
*
* @param <K> type of the key
* @param <V> type of the pooled object
- *
* @since 2.0
*/
public class ProxiedKeyedObjectPool<K, V> implements KeyedObjectPool<K, V> {
diff --git
a/src/main/java/org/apache/commons/pool2/proxy/ProxiedObjectPool.java
b/src/main/java/org/apache/commons/pool2/proxy/ProxiedObjectPool.java
index 00d5e80c..610b32b0 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/ProxiedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/ProxiedObjectPool.java
@@ -26,7 +26,6 @@ import org.apache.commons.pool2.UsageTracking;
* object to the pool.
*
* @param <T> type of the pooled object
- *
* @since 2.0
*/
public class ProxiedObjectPool<T> implements ObjectPool<T> {
diff --git a/src/main/java/org/apache/commons/pool2/proxy/ProxySource.java
b/src/main/java/org/apache/commons/pool2/proxy/ProxySource.java
index e756857a..69bddb68 100644
--- a/src/main/java/org/apache/commons/pool2/proxy/ProxySource.java
+++ b/src/main/java/org/apache/commons/pool2/proxy/ProxySource.java
@@ -23,7 +23,6 @@ import org.apache.commons.pool2.UsageTracking;
* {@link ProxiedObjectPool} to create proxies as required.
*
* @param <T> type of the pooled object to be proxied
- *
* @since 2.0
*/
interface ProxySource<T> {
@@ -44,7 +43,6 @@ interface ProxySource<T> {
* Resolves the wrapped object from the given proxy.
*
* @param proxy The proxy object
- *
* @return The pooled object wrapped by the given proxy
*/
T resolveProxy(T proxy);
diff --git
a/src/test/java/org/apache/commons/pool2/AbstractTestKeyedObjectPool.java
b/src/test/java/org/apache/commons/pool2/AbstractTestKeyedObjectPool.java
index af0b3d5a..11a93603 100644
--- a/src/test/java/org/apache/commons/pool2/AbstractTestKeyedObjectPool.java
+++ b/src/test/java/org/apache/commons/pool2/AbstractTestKeyedObjectPool.java
@@ -194,7 +194,6 @@ public abstract class AbstractTestKeyedObjectPool {
*
* @param key Key for the object to be obtained
* @param n index of the object to be obtained
- *
* @return the requested object
*/
protected abstract Object getNthObject(Object key, int n);
@@ -211,7 +210,6 @@ public abstract class AbstractTestKeyedObjectPool {
* if such a pool cannot be created.
*
* @param minCapacity Minimum capacity of the pool to create
- *
* @return the newly created keyed object pool
*/
protected abstract <E extends Exception> KeyedObjectPool<Object, Object>
makeEmptyPool(int minCapacity);
diff --git a/src/test/java/org/apache/commons/pool2/AbstractTestObjectPool.java
b/src/test/java/org/apache/commons/pool2/AbstractTestObjectPool.java
index 165a6cce..a81afce0 100644
--- a/src/test/java/org/apache/commons/pool2/AbstractTestObjectPool.java
+++ b/src/test/java/org/apache/commons/pool2/AbstractTestObjectPool.java
@@ -61,7 +61,6 @@ public abstract class AbstractTestObjectPool {
*
* @param <E> The exception type throws by the pool
* @param factory The factory to be used by the object pool
- *
* @return the newly created empty pool
*
* @throws UnsupportedOperationException if the pool being tested does not
diff --git a/src/test/java/org/apache/commons/pool2/TestBaseObjectPool.java
b/src/test/java/org/apache/commons/pool2/TestBaseObjectPool.java
index bae3e856..c65d5257 100644
--- a/src/test/java/org/apache/commons/pool2/TestBaseObjectPool.java
+++ b/src/test/java/org/apache/commons/pool2/TestBaseObjectPool.java
@@ -47,7 +47,6 @@ public class TestBaseObjectPool extends
AbstractTestObjectPool {
/**
* @param n Ignored by this implemented. Used by sub-classes.
- *
* @return the Nth object (zero indexed)
*/
protected Object getNthObject(final int n) {
@@ -73,7 +72,6 @@ public class TestBaseObjectPool extends
AbstractTestObjectPool {
/**
* @param minCapacity Ignored by this implemented. Used by sub-classes.
- *
* @return A newly created empty pool
*/
protected <E extends Exception> ObjectPool<String> makeEmptyPool(final int
minCapacity) {
