No need for blank Javadoc lines between Javadoc @ tags

apache · Nov 28, 2024 · 269ed25 · 269ed25
1 parent 4edc3dc
commit 269ed25
Show file tree

Hide file tree

Showing 29 changed files with 0 additions and 121 deletions.
diff --git a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
@@ -28,10 +28,8 @@
  * </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 void activateObject(final K key, final PooledObject<V> p) throws Exceptio
      *
      * @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
@@ -25,7 +25,6 @@
  * </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 void addObject() throws Exception {
      * 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
@@ -26,10 +26,8 @@
  * 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 void activateObject(final PooledObject<T> p) throws Exception {
      * 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 void passivateObject(final PooledObject<T> p) throws Exception {
      * Always returns {@code true}.
      *
      * @param p ignored
-     *
      * @return {@code true}
      */
     @Override
@@ -98,7 +94,6 @@ public boolean validateObject(final PooledObject<T> 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
@@ -66,7 +66,6 @@
  * @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 @@ default void addObjects(final K key, final int count) throws Exception {
      * </p>
      *
      * @param key the key used to obtain the object
-     *
      * @return an instance from this pool.
      *
      * @throws IllegalStateException
@@ -190,7 +187,6 @@ default void addObjects(final K key, final int count) throws Exception {
      * 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 @@ default List<K> getKeys() {
      *
      * @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 @@ default List<K> getKeys() {
      * @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 @@ default void invalidateObject(final K key, final V obj, final DestroyMode destro
      *
      * @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
@@ -68,10 +68,8 @@
  *
  * @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 @@ default void destroyObject(final K key, final PooledObject<V> p, final DestroyMo
      * 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 @@ default void destroyObject(final K key, final PooledObject<V> p, final DestroyMo
      *
      * @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 @@ default void destroyObject(final K key, final PooledObject<V> p, final DestroyMo
      *
      * @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
@@ -55,7 +55,6 @@
  * @see PooledObjectFactory
  * @see KeyedObjectPool
  * @see BaseObjectPool
- *
  * @since 2.0
  */
 public interface ObjectPool<T> extends Closeable {
@@ -111,7 +110,6 @@ default void addObjects(final int count) throws Exception {
      * </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 @@ default void addObjects(final int count) throws Exception {
      * </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 @@ default void invalidateObject(final T obj, final DestroyMode destroyMode) throws
      * 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
@@ -1333,7 +1333,6 @@ static class TimerHolder {
      *            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 static <K, V> Map<K, TimerTask> checkMinIdle(
      *            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 static <K, V> TimerTask checkMinIdle(
      *            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 static void checkRethrow(final Throwable t) {
      *            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 static <K, V> KeyedObjectPool<K, V> erodingPool(final KeyedObjectPool<K,
      *            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 static <K, V> KeyedObjectPool<K, V> erodingPool(final KeyedObjectPool<K,
      *            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 static <K, V> KeyedObjectPool<K, V> erodingPool(
      *            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 static <T> ObjectPool<T> erodingPool(final ObjectPool<T> pool) {
      *            shrinks more aggressively. If 1 &lt; 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 @@ private static Timer getMinIdleTimer() {
      *            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 static <K, V> void prefill(final KeyedObjectPool<K, V> keyedPool,
      *            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 static <K, V> void prefill(final KeyedObjectPool<K, V> keyedPool,
      * @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 static <K, V> KeyedPooledObjectFactory<K, V> synchronizedKeyedPooledFacto
      *            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
@@ -65,7 +65,6 @@
  * </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 @@ default void destroyObject(final PooledObject<T> p, final DestroyMode destroyMod
    * {@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 @@ default void destroyObject(final PooledObject<T> p, final DestroyMode destroyMod
    * 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 @@ default void destroyObject(final PooledObject<T> p, final DestroyMode destroyMod
    * 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
@@ -22,7 +22,6 @@
  * 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> {