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 df218c16 No need for blank Javadoc lines between Javadoc @ tags df218c16 is described below commit df218c16b64d4a10ff39b8fd3cc0e1794be58dc5 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu Nov 28 11:34:51 2024 -0500 No need for blank Javadoc lines between Javadoc @ tags --- .../pool3/BaseKeyedPooledObjectFactory.java | 3 --- .../org/apache/commons/pool3/BaseObjectPool.java | 2 -- .../commons/pool3/BasePooledObjectFactory.java | 5 ---- .../org/apache/commons/pool3/KeyedObjectPool.java | 9 -------- .../commons/pool3/KeyedPooledObjectFactory.java | 8 ------- .../java/org/apache/commons/pool3/ObjectPool.java | 5 ---- .../apache/commons/pool3/PooledObjectFactory.java | 8 ------- .../org/apache/commons/pool3/UsageTracking.java | 1 - .../commons/pool3/impl/BaseGenericObjectPool.java | 8 ------- .../commons/pool3/impl/BaseObjectPoolConfig.java | 3 --- .../commons/pool3/impl/DefaultEvictionPolicy.java | 1 - .../commons/pool3/impl/DefaultPooledObject.java | 1 - .../pool3/impl/DefaultPooledObjectInfoMBean.java | 2 -- .../commons/pool3/impl/GenericKeyedObjectPool.java | 19 --------------- .../pool3/impl/GenericKeyedObjectPoolMXBean.java | 1 - .../commons/pool3/impl/GenericObjectPool.java | 8 ------- .../commons/pool3/impl/LinkedBlockingDeque.java | 27 ---------------------- .../apache/commons/pool3/impl/PoolImplUtils.java | 3 --- .../pool3/impl/SoftReferenceObjectPool.java | 1 - .../commons/pool3/proxy/BaseProxyHandler.java | 1 - .../commons/pool3/proxy/CglibProxyHandler.java | 1 - .../commons/pool3/proxy/CglibProxySource.java | 1 - .../commons/pool3/proxy/JdkProxyHandler.java | 1 - .../apache/commons/pool3/proxy/JdkProxySource.java | 1 - .../pool3/proxy/ProxiedKeyedObjectPool.java | 1 - .../commons/pool3/proxy/ProxiedObjectPool.java | 1 - .../apache/commons/pool3/proxy/ProxySource.java | 2 -- .../commons/pool3/AbstractTestKeyedObjectPool.java | 2 -- .../commons/pool3/AbstractTestObjectPool.java | 2 -- .../apache/commons/pool3/TestBaseObjectPool.java | 2 -- 30 files changed, 130 deletions(-) diff --git a/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java b/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java index e64e9375..cd6b7282 100644 --- a/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java +++ b/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java @@ -28,11 +28,9 @@ 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. * @param <E> Type of exception thrown by this factory. - * * @since 2.0 */ public abstract class BaseKeyedPooledObjectFactory<K, V, E extends Exception> extends BaseObject implements KeyedPooledObjectFactory<K, V, E> { @@ -56,7 +54,6 @@ public abstract class BaseKeyedPooledObjectFactory<K, V, E extends Exception> ex * * @param key the key used when constructing the object * @return an instance that can be served by the pool - * * @throws E 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/pool3/BaseObjectPool.java b/src/main/java/org/apache/commons/pool3/BaseObjectPool.java index 70a684ff..6be12065 100644 --- a/src/main/java/org/apache/commons/pool3/BaseObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/BaseObjectPool.java @@ -26,7 +26,6 @@ package org.apache.commons.pool3; * * @param <T> Type of element pooled in this pool. * @param <E> Type of exception thrown by this pool. - * * @since 2.0 */ public abstract class BaseObjectPool<T, E extends Exception> extends BaseObject implements ObjectPool<T, E> { @@ -50,7 +49,6 @@ public abstract class BaseObjectPool<T, E extends Exception> extends BaseObject * 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/pool3/BasePooledObjectFactory.java b/src/main/java/org/apache/commons/pool3/BasePooledObjectFactory.java index 52b699c7..ec78f088 100644 --- a/src/main/java/org/apache/commons/pool3/BasePooledObjectFactory.java +++ b/src/main/java/org/apache/commons/pool3/BasePooledObjectFactory.java @@ -27,10 +27,8 @@ import java.util.Objects; * * @param <T> Type of element managed in this factory. * @param <E> Type of exception thrown in this factory. - * * @see PooledObjectFactory * @see BaseKeyedPooledObjectFactory - * * @since 2.0 */ public abstract class BasePooledObjectFactory<T, E extends Exception> extends BaseObject implements PooledObjectFactory<T, E> { @@ -51,7 +49,6 @@ public abstract class BasePooledObjectFactory<T, E extends Exception> extends Ba * invocation.</p> * * @return an instance to be served by the pool, not null. - * * @throws E if there is a problem creating a new instance, * this will be propagated to the code requesting an object. */ @@ -86,7 +83,6 @@ public abstract class BasePooledObjectFactory<T, E extends Exception> extends Ba * Always returns {@code true}. * * @param p ignored - * * @return {@code true} */ @Override @@ -99,7 +95,6 @@ public abstract class BasePooledObjectFactory<T, E extends Exception> extends Ba * {@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/pool3/KeyedObjectPool.java b/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java index 4fdb9bfb..012d3f6d 100644 --- a/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java @@ -62,11 +62,9 @@ import java.util.NoSuchElementException; * @param <K> The type of keys maintained by this pool. * @param <V> Type of element pooled in this pool. * @param <E> Type of exception thrown by this pool. - * * @see KeyedPooledObjectFactory * @see ObjectPool * @see org.apache.commons.pool3.impl.GenericKeyedObjectPool GenericKeyedObjectPool - * * @since 2.0 */ public interface KeyedObjectPool<K, V, E extends Exception> extends Closeable { @@ -78,7 +76,6 @@ public interface KeyedObjectPool<K, V, E extends Exception> extends Closeable { * "pre-loading" a pool with idle objects (Optional operation). * * @param key the key a new instance should be added to - * * @throws E * when {@link KeyedPooledObjectFactory#makeObject} fails. * @throws IllegalStateException @@ -161,9 +158,7 @@ public interface KeyedObjectPool<K, V, E extends Exception> extends Closeable { * </p> * * @param key the key used to obtain the object - * * @return an instance from this pool. - * * @throws IllegalStateException * after {@link #close close} has been called on this pool * @throws E @@ -190,7 +185,6 @@ public interface KeyedObjectPool<K, V, E extends Exception> extends Closeable { * the given {@code key} (optional operation). * * @param key the key to clear - * * @throws UnsupportedOperationException when this implementation doesn't * support the operation * @@ -276,7 +270,6 @@ public interface KeyedObjectPool<K, V, E extends Exception> extends Closeable { * * @param key the key used to obtain the object * @param obj a {@link #borrowObject borrowed} instance to be returned. - * * @throws E if the instance cannot be invalidated */ void invalidateObject(K key, V obj) throws E; @@ -299,7 +292,6 @@ public interface KeyedObjectPool<K, V, E extends Exception> 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 E if the instance cannot be invalidated * @since 2.9.0 */ @@ -316,7 +308,6 @@ public interface KeyedObjectPool<K, V, E extends Exception> 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/pool3/KeyedPooledObjectFactory.java b/src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java index a06cdd60..0bcd485a 100644 --- a/src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java +++ b/src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java @@ -68,11 +68,9 @@ package org.apache.commons.pool3; * * @see KeyedObjectPool * @see BaseKeyedPooledObjectFactory - * * @param <K> The type of keys managed by this factory. * @param <V> Type of element managed by this factory. * @param <E> Type of exception thrown by this factory. - * * @since 2.0 */ public interface KeyedPooledObjectFactory<K, V, E extends Exception> { @@ -82,7 +80,6 @@ public interface KeyedPooledObjectFactory<K, V, E extends Exception> { * * @param key the key used when selecting the object * @param p a {@code PooledObject} wrapping the instance to be activated - * * @throws E if there is a problem activating {@code obj}, * this exception may be swallowed by the pool. * @@ -104,7 +101,6 @@ public interface KeyedPooledObjectFactory<K, V, E extends Exception> { * * @param key the key used when selecting the instance * @param p a {@code PooledObject} wrapping the instance to be destroyed - * * @throws E should be avoided as it may be swallowed by * the pool implementation. * @@ -119,7 +115,6 @@ public interface KeyedPooledObjectFactory<K, V, E extends Exception> { * @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 E should be avoided as it may be swallowed by * the pool implementation. * @@ -138,7 +133,6 @@ public interface KeyedPooledObjectFactory<K, V, E extends Exception> { * 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. * @@ -152,7 +146,6 @@ public interface KeyedPooledObjectFactory<K, V, E extends Exception> { * * @param key the key used when selecting the object * @param p a {@code PooledObject} wrapping the instance to be passivated - * * @throws E if there is a problem passivating {@code obj}, * this exception may be swallowed by the pool. * @@ -165,7 +158,6 @@ public interface KeyedPooledObjectFactory<K, V, E extends Exception> { * * @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/pool3/ObjectPool.java b/src/main/java/org/apache/commons/pool3/ObjectPool.java index 50dfb1ea..3d87410f 100644 --- a/src/main/java/org/apache/commons/pool3/ObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/ObjectPool.java @@ -51,11 +51,9 @@ import java.util.NoSuchElementException; * * @param <T> Type of element pooled in this pool. * @param <E> Type of exception thrown by this pool. - * * @see PooledObjectFactory * @see KeyedObjectPool * @see BaseObjectPool - * * @since 2.0 */ public interface ObjectPool<T, E extends Exception> extends Closeable { @@ -111,7 +109,6 @@ public interface ObjectPool<T, E extends Exception> extends Closeable { * </p> * * @return an instance from this pool. - * * @throws IllegalStateException * after {@link #close close} has been called on this pool. * @throws E @@ -177,7 +174,6 @@ public interface ObjectPool<T, E extends Exception> extends Closeable { * </p> * * @param obj a {@link #borrowObject borrowed} instance to be disposed. - * * @throws E if the instance cannot be invalidated */ void invalidateObject(T obj) throws E; @@ -210,7 +206,6 @@ public interface ObjectPool<T, E extends Exception> 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/pool3/PooledObjectFactory.java b/src/main/java/org/apache/commons/pool3/PooledObjectFactory.java index 3742b07c..a1cc24f2 100644 --- a/src/main/java/org/apache/commons/pool3/PooledObjectFactory.java +++ b/src/main/java/org/apache/commons/pool3/PooledObjectFactory.java @@ -66,9 +66,7 @@ package org.apache.commons.pool3; * * @param <T> Type of element managed in this factory. * @param <E> Type of exception thrown in this factory. - * * @see ObjectPool - * * @since 2.0 */ public interface PooledObjectFactory<T, E extends Exception> { @@ -77,7 +75,6 @@ public interface PooledObjectFactory<T, E extends Exception> { * Reinitializes an instance to be returned by the pool. * * @param p a {@code PooledObject} wrapping the instance to be activated - * * @throws E if there is a problem activating {@code obj}, * this exception may be swallowed by the pool. * @@ -99,7 +96,6 @@ public interface PooledObjectFactory<T, E extends Exception> { * </p> * * @param p a {@code PooledObject} wrapping the instance to be destroyed - * * @throws E should be avoided as it may be swallowed by * the pool implementation. * @@ -114,7 +110,6 @@ public interface PooledObjectFactory<T, E extends Exception> { * * @param p a {@code PooledObject} wrapping the instance to be destroyed * @param destroyMode DestroyMode providing context to the factory - * * @throws E should be avoided as it may be swallowed by * the pool implementation. * @@ -133,7 +128,6 @@ public interface PooledObjectFactory<T, E extends Exception> { * {@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 E if there is a problem creating a new instance, * this will be propagated to the code requesting an object. */ @@ -143,7 +137,6 @@ public interface PooledObjectFactory<T, E extends Exception> { * Uninitializes an instance to be returned to the idle object pool. * * @param p a {@code PooledObject} wrapping the instance to be passivated - * * @throws E if there is a problem passivating {@code obj}, * this exception may be swallowed by the pool. * @@ -155,7 +148,6 @@ public interface PooledObjectFactory<T, E extends Exception> { * 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/pool3/UsageTracking.java b/src/main/java/org/apache/commons/pool3/UsageTracking.java index 9543da49..397f9041 100644 --- a/src/main/java/org/apache/commons/pool3/UsageTracking.java +++ b/src/main/java/org/apache/commons/pool3/UsageTracking.java @@ -22,7 +22,6 @@ package org.apache.commons.pool3; * 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/pool3/impl/BaseGenericObjectPool.java b/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java index 0095a20f..ffd2eaab 100644 --- a/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java @@ -604,7 +604,6 @@ public abstract class BaseGenericObjectPool<T, E extends Exception> extends Base * will be run. * * @return duration to sleep between evictor runs - * * @see #setDurationBetweenEvictionRuns(Duration) * @since 2.11.0 */ @@ -628,7 +627,6 @@ public abstract class BaseGenericObjectPool<T, E extends Exception> extends Base * used by this pool. * * @return The fully qualified class name of the {@link EvictionPolicy} - * * @see #setEvictionPolicyClassName(String) */ public final String getEvictionPolicyClassName() { @@ -889,7 +887,6 @@ public abstract class BaseGenericObjectPool<T, E extends Exception> extends Base * tested per run. * * @return max number of objects to examine during each evictor run - * * @see #setNumTestsPerEvictionRun * @see #setDurationBetweenEvictionRuns(Duration) */ @@ -1060,7 +1057,6 @@ public abstract class BaseGenericObjectPool<T, E extends Exception> extends Base * being returned from the {@code borrowObject()} method * * @see #setTestOnCreate - * * @since 2.2 */ public final boolean getTestOnCreate() { @@ -1092,7 +1088,6 @@ public abstract class BaseGenericObjectPool<T, E extends Exception> extends Base * the pool and destroyed. * * @return {@code true} if objects will be validated by the evictor - * * @see #setTestWhileIdle * @see #setDurationBetweenEvictionRuns(Duration) */ @@ -1106,7 +1101,6 @@ public abstract class BaseGenericObjectPool<T, E extends Exception> extends Base * will be run. * * @return number of milliseconds to sleep between evictor runs - * * @see #setDurationBetweenEvictionRuns(Duration) * @deprecated Use {@link #getDurationBetweenEvictionRuns()}. */ @@ -1227,7 +1221,6 @@ public abstract class BaseGenericObjectPool<T, E extends Exception> extends Base * Sets the abandoned object removal configuration. * * @param abandonedConfig the new configuration to use. This is used by value. - * * @see AbandonedConfig * @since 2.11.0 */ @@ -1562,7 +1555,6 @@ public abstract class BaseGenericObjectPool<T, E extends Exception> extends Base * {@code borrowObject()} method * * @see #getTestOnCreate - * * @since 2.2 */ public final void setTestOnCreate(final boolean testOnCreate) { diff --git a/src/main/java/org/apache/commons/pool3/impl/BaseObjectPoolConfig.java b/src/main/java/org/apache/commons/pool3/impl/BaseObjectPoolConfig.java index 54bc29c1..89d3a776 100644 --- a/src/main/java/org/apache/commons/pool3/impl/BaseObjectPoolConfig.java +++ b/src/main/java/org/apache/commons/pool3/impl/BaseObjectPoolConfig.java @@ -94,7 +94,6 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon * The default value for the {@code testOnCreate} configuration attribute. * @see GenericObjectPool#getTestOnCreate() * @see GenericKeyedObjectPool#getTestOnCreate() - * * @since 2.2 */ public static final boolean DEFAULT_TEST_ON_CREATE = false; @@ -424,7 +423,6 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon * * @see GenericObjectPool#getTestOnCreate() * @see GenericKeyedObjectPool#getTestOnCreate() - * * @since 2.2 */ public boolean getTestOnCreate() { @@ -682,7 +680,6 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon * * @see GenericObjectPool#getTestOnCreate() * @see GenericKeyedObjectPool#getTestOnCreate() - * * @since 2.2 */ public void setTestOnCreate(final boolean testOnCreate) { diff --git a/src/main/java/org/apache/commons/pool3/impl/DefaultEvictionPolicy.java b/src/main/java/org/apache/commons/pool3/impl/DefaultEvictionPolicy.java index fa016a25..23582a4b 100644 --- a/src/main/java/org/apache/commons/pool3/impl/DefaultEvictionPolicy.java +++ b/src/main/java/org/apache/commons/pool3/impl/DefaultEvictionPolicy.java @@ -38,7 +38,6 @@ import org.apache.commons.pool3.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/pool3/impl/DefaultPooledObject.java b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java index de826805..23eff043 100644 --- a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java +++ b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java @@ -35,7 +35,6 @@ import org.apache.commons.pool3.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/pool3/impl/DefaultPooledObjectInfoMBean.java b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfoMBean.java index 6e97d9db..1e08f0b0 100644 --- a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfoMBean.java +++ b/src/main/java/org/apache/commons/pool3/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/pool3/impl/GenericKeyedObjectPool.java b/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java index 48b518f1..4bbf3735 100644 --- a/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java @@ -83,11 +83,9 @@ import org.apache.commons.pool3.UsageTracking; * </p> * * @see GenericObjectPool - * * @param <K> The type of keys maintained by this pool. * @param <T> Type of element pooled in this pool. * @param <E> Type of exception thrown in this pool. - * * @since 2.0 */ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGenericObjectPool<T, E> @@ -298,7 +296,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * * @param key The key to associate with the idle object * @param p The wrapped object to add. - * * @throws E If the associated factory fails to passivate the object */ private void addIdleObject(final K key, final PooledObject<T> p) throws E { @@ -328,7 +325,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * </p> * * @param key the key a new instance should be added to - * * @throws E when {@link KeyedPooledObjectFactory#makeObject} * fails. */ @@ -409,7 +405,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * 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. * @@ -523,7 +518,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * 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) { @@ -720,9 +714,7 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * 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 E If the objection creation fails. */ private PooledObject<T> create(final K key) throws E { @@ -869,7 +861,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * @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 E If the object destruction failed */ @@ -932,7 +923,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * </p> * * @param key The key to check for idle objects - * * @throws E If a new object is required and cannot be created */ private void ensureMinIdle(final K key) throws E { @@ -1155,7 +1145,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * 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 @@ -1296,7 +1285,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * * @param key pool key * @param obj instance to invalidate - * * @throws E if an exception occurs destroying the * object * @throws IllegalStateException if obj does not belong to the pool @@ -1317,7 +1305,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * @param key pool key * @param obj instance to invalidate * @param destroyMode DestroyMode context provided to factory - * * @throws E if an exception occurs destroying the * object * @throws IllegalStateException if obj does not belong to the pool @@ -1362,7 +1349,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * {@link #getMinIdlePerKey()} idle instances are created. * * @param key The key to register for pool control. - * * @throws E If the associated factory throws an exception */ public void preparePool(final K key) throws E { @@ -1380,7 +1366,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * </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. @@ -1463,7 +1448,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * * @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 @@ -1609,7 +1593,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * Sets the configuration. * * @param conf the new configuration to use. This is used by value. - * * @see GenericKeyedObjectPoolConfig */ public void setConfig(final GenericKeyedObjectPoolConfig<T> conf) { @@ -1646,7 +1629,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * 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) { @@ -1667,7 +1649,6 @@ public class GenericKeyedObjectPool<K, T, E extends Exception> extends BaseGener * </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/pool3/impl/GenericKeyedObjectPoolMXBean.java b/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPoolMXBean.java index 0f46b71a..51a84e2d 100644 --- a/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPoolMXBean.java +++ b/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPoolMXBean.java @@ -29,7 +29,6 @@ import java.util.Map; * </p> * * @param <K> The type of keys maintained by the pool. - * * @since 2.0 */ public interface GenericKeyedObjectPoolMXBean<K> { diff --git a/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java b/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java index 7d957177..0a73a32c 100644 --- a/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java @@ -74,10 +74,8 @@ import org.apache.commons.pool3.UsageTracking; * </p> * * @see GenericKeyedObjectPool - * * @param <T> Type of element pooled in this pool. * @param <E> Type of exception thrown in this pool. - * * @since 2.0 */ public class GenericObjectPool<T, E extends Exception> extends BaseGenericObjectPool<T, E> @@ -188,7 +186,6 @@ public class GenericObjectPool<T, E extends Exception> extends BaseGenericObject * is null, this is a no-op (no exception, but no impact on the pool). * * @param p The object to make idle - * * @throws E If the factory fails to passivate the object */ private void addIdleObject(final PooledObject<T> p) throws E { @@ -419,9 +416,7 @@ public class GenericObjectPool<T, E extends Exception> extends BaseGenericObject * to become available * * @return object instance from the pool - * * @throws NoSuchElementException if an instance cannot be returned - * * @throws E if an object instance cannot be returned due to an * error */ @@ -609,7 +604,6 @@ public class GenericObjectPool<T, E extends Exception> extends BaseGenericObject * * @param toDestroy The wrapped pooled object to destroy * @param destroyMode DestroyMode context provided to the factory - * * @throws E If the factory fails to destroy the pooled object * cleanly */ @@ -856,7 +850,6 @@ public class GenericObjectPool<T, E extends Exception> extends BaseGenericObject * </p> * * @return The minimum number of objects. - * * @see #setMinIdle(int) * @see #setMaxIdle(int) * @see #setDurationBetweenEvictionRuns(Duration) @@ -1119,7 +1112,6 @@ public class GenericObjectPool<T, E extends Exception> extends BaseGenericObject * Sets the base pool configuration. * * @param conf the new configuration to use. This is used by value. - * * @see GenericObjectPoolConfig */ public void setConfig(final GenericObjectPoolConfig<T> conf) { diff --git a/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java b/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java index f18dec1f..b4232df5 100644 --- a/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java +++ b/src/main/java/org/apache/commons/pool3/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,9 +474,7 @@ 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 * supported by the specified collection * @throws ClassCastException if the class of the elements held by this @@ -496,7 +493,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 +623,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 +647,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,9 +683,7 @@ 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 * @throws InterruptedException if the thread is interrupted whilst waiting * for space @@ -709,9 +701,7 @@ 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 * @throws InterruptedException if the thread is interrupted whilst waiting * for space @@ -740,9 +730,7 @@ 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 * @throws InterruptedException if the thread is interrupted whilst waiting * for space @@ -771,9 +759,7 @@ 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 * @throws InterruptedException if the thread is interrupted whilst waiting * for space @@ -802,9 +788,7 @@ 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 * @throws InterruptedException if the thread is interrupted whist waiting * for space @@ -833,9 +817,7 @@ 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 * @throws InterruptedException if the thread is interrupted whist waiting * for space @@ -883,7 +865,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 +880,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 +902,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 +928,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 +950,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 +977,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 +1010,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 +1023,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 +1044,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/pool3/impl/PoolImplUtils.java b/src/main/java/org/apache/commons/pool3/impl/PoolImplUtils.java index b15a311b..0233f329 100644 --- a/src/main/java/org/apache/commons/pool3/impl/PoolImplUtils.java +++ b/src/main/java/org/apache/commons/pool3/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/pool3/impl/SoftReferenceObjectPool.java b/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java index 5847697e..c5cd39a4 100644 --- a/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java @@ -257,7 +257,6 @@ public class SoftReferenceObjectPool<T, E extends Exception> extends BaseObjectP * references pools. * * @param toDestroy PooledSoftReference to destroy - * * @throws E If an error occurs while trying to destroy the object */ private void destroy(final PooledSoftReference<T> toDestroy) throws E { diff --git a/src/main/java/org/apache/commons/pool3/proxy/BaseProxyHandler.java b/src/main/java/org/apache/commons/pool3/proxy/BaseProxyHandler.java index 8af3d809..3d655ef4 100644 --- a/src/main/java/org/apache/commons/pool3/proxy/BaseProxyHandler.java +++ b/src/main/java/org/apache/commons/pool3/proxy/BaseProxyHandler.java @@ -25,7 +25,6 @@ import org.apache.commons.pool3.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/pool3/proxy/CglibProxyHandler.java b/src/main/java/org/apache/commons/pool3/proxy/CglibProxyHandler.java index 8134ae07..ff3db18d 100644 --- a/src/main/java/org/apache/commons/pool3/proxy/CglibProxyHandler.java +++ b/src/main/java/org/apache/commons/pool3/proxy/CglibProxyHandler.java @@ -29,7 +29,6 @@ import net.sf.cglib.proxy.MethodProxy; * CGLib implementation of the proxy handler. * </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/pool3/proxy/CglibProxySource.java b/src/main/java/org/apache/commons/pool3/proxy/CglibProxySource.java index 87313d3c..ca52c23b 100644 --- a/src/main/java/org/apache/commons/pool3/proxy/CglibProxySource.java +++ b/src/main/java/org/apache/commons/pool3/proxy/CglibProxySource.java @@ -27,7 +27,6 @@ import net.sf.cglib.proxy.Factory; * Provides proxy objects using CGLib. * </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/pool3/proxy/JdkProxyHandler.java b/src/main/java/org/apache/commons/pool3/proxy/JdkProxyHandler.java index 58d2d614..662bbe95 100644 --- a/src/main/java/org/apache/commons/pool3/proxy/JdkProxyHandler.java +++ b/src/main/java/org/apache/commons/pool3/proxy/JdkProxyHandler.java @@ -25,7 +25,6 @@ import org.apache.commons.pool3.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/pool3/proxy/JdkProxySource.java b/src/main/java/org/apache/commons/pool3/proxy/JdkProxySource.java index 8ff793bf..46edc518 100644 --- a/src/main/java/org/apache/commons/pool3/proxy/JdkProxySource.java +++ b/src/main/java/org/apache/commons/pool3/proxy/JdkProxySource.java @@ -25,7 +25,6 @@ import org.apache.commons.pool3.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/pool3/proxy/ProxiedKeyedObjectPool.java b/src/main/java/org/apache/commons/pool3/proxy/ProxiedKeyedObjectPool.java index 1a3a31e7..9595ef6e 100644 --- a/src/main/java/org/apache/commons/pool3/proxy/ProxiedKeyedObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/proxy/ProxiedKeyedObjectPool.java @@ -31,7 +31,6 @@ import org.apache.commons.pool3.UsageTracking; * @param <K> type of the key * @param <V> type of the pooled object * @param <E> type of exception thrown by this pool - * * @since 2.0 */ public class ProxiedKeyedObjectPool<K, V, E extends Exception> implements KeyedObjectPool<K, V, E> { diff --git a/src/main/java/org/apache/commons/pool3/proxy/ProxiedObjectPool.java b/src/main/java/org/apache/commons/pool3/proxy/ProxiedObjectPool.java index 24f3fa1d..04001268 100644 --- a/src/main/java/org/apache/commons/pool3/proxy/ProxiedObjectPool.java +++ b/src/main/java/org/apache/commons/pool3/proxy/ProxiedObjectPool.java @@ -29,7 +29,6 @@ import org.apache.commons.pool3.UsageTracking; * * @param <T> type of the pooled object * @param <E> type of the exception - * * @since 2.0 */ public class ProxiedObjectPool<T, E extends Exception> implements ObjectPool<T, E> { diff --git a/src/main/java/org/apache/commons/pool3/proxy/ProxySource.java b/src/main/java/org/apache/commons/pool3/proxy/ProxySource.java index 34d157fc..9241a0fe 100644 --- a/src/main/java/org/apache/commons/pool3/proxy/ProxySource.java +++ b/src/main/java/org/apache/commons/pool3/proxy/ProxySource.java @@ -23,7 +23,6 @@ import org.apache.commons.pool3.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/pool3/AbstractTestKeyedObjectPool.java b/src/test/java/org/apache/commons/pool3/AbstractTestKeyedObjectPool.java index 865d0f4d..1e958f81 100644 --- a/src/test/java/org/apache/commons/pool3/AbstractTestKeyedObjectPool.java +++ b/src/test/java/org/apache/commons/pool3/AbstractTestKeyedObjectPool.java @@ -192,7 +192,6 @@ public abstract class AbstractTestKeyedObjectPool { * for the given key. * @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); @@ -208,7 +207,6 @@ public abstract class AbstractTestKeyedObjectPool { * throw {@link IllegalArgumentException} * 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, E> makeEmptyPool(int minCapacity); diff --git a/src/test/java/org/apache/commons/pool3/AbstractTestObjectPool.java b/src/test/java/org/apache/commons/pool3/AbstractTestObjectPool.java index 73a703c4..ef8cc6f7 100644 --- a/src/test/java/org/apache/commons/pool3/AbstractTestObjectPool.java +++ b/src/test/java/org/apache/commons/pool3/AbstractTestObjectPool.java @@ -61,9 +61,7 @@ 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 * follow pool contracts. */ diff --git a/src/test/java/org/apache/commons/pool3/TestBaseObjectPool.java b/src/test/java/org/apache/commons/pool3/TestBaseObjectPool.java index a30a057f..c808e5a5 100644 --- a/src/test/java/org/apache/commons/pool3/TestBaseObjectPool.java +++ b/src/test/java/org/apache/commons/pool3/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, E> makeEmptyPool(final int minCapacity) {