No need for blank Javadoc lines between Javadoc @ tags

Author: garydgregory

src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java

@@ -28,11 +28,9 @@
  * </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 void activateObject(final K key, final PooledObject<V> p) throws E {
      *
      * @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.
      */

src/main/java/org/apache/commons/pool3/BaseObjectPool.java

@@ -26,7 +26,6 @@
  *
  * @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 void addObject() throws E, UnsupportedOperationException {
      * closed.
      *
      * @throws IllegalStateException when this pool has been closed.
-     *
      * @see #isClosed()
      */
     protected final void assertOpen() throws IllegalStateException {

src/main/java/org/apache/commons/pool3/BasePooledObjectFactory.java

@@ -27,10 +27,8 @@
  *
  * @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 void activateObject(final PooledObject<T> p) throws E {
      * 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 void passivateObject(final PooledObject<T> p) throws E {
      * Always returns {@code true}.
      *
      * @param p ignored
-     *
      * @return {@code true}
      */
     @Override
@@ -99,7 +95,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);

src/main/java/org/apache/commons/pool3/KeyedObjectPool.java

@@ -62,11 +62,9 @@
  * @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 @@ default void addObjects(final K key, final int count) throws E, IllegalArgumentE
      * </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 @@ default void addObjects(final K key, final int count) throws E, IllegalArgumentE
      * 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 @@ default List<K> getKeys() {
      *
      * @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 @@ 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 E if the instance cannot be invalidated
      * @since 2.9.0
      */
@@ -316,7 +308,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).

src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java

@@ -68,11 +68,9 @@
  *
  * @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 @@ 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.
      *
@@ -152,7 +146,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 E if there is a problem passivating {@code obj},
      *    this exception may be swallowed by the pool.
      *
@@ -165,7 +158,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.
      */

src/main/java/org/apache/commons/pool3/ObjectPool.java

@@ -51,11 +51,9 @@
  *
  * @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 @@ default void addObjects(final int count) throws E {
      * </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 @@ default void addObjects(final int count) throws E {
      * </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 @@ 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).

src/main/java/org/apache/commons/pool3/PooledObjectFactory.java

@@ -66,9 +66,7 @@
  *
  * @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 @@ 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 E if there is a problem creating a new instance,
    *    this will be propagated to the code requesting an object.
    */
@@ -143,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 E if there is a problem passivating {@code obj},
    *    this exception may be swallowed by the pool.
    *
@@ -155,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.
    */

src/main/java/org/apache/commons/pool3/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> {

src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java

@@ -604,7 +604,6 @@ public final long getDestroyedCount() {
      * will be run.
      *
      * @return duration to sleep between evictor runs
-     *
      * @see #setDurationBetweenEvictionRuns(Duration)
      * @since 2.11.0
      */
@@ -628,7 +627,6 @@ public EvictionPolicy<T> getEvictionPolicy() {
      * 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 final long getMinEvictableIdleTimeMillis() {
      * tested per run.
      *
      * @return max number of objects to examine during each evictor run
-     *
      * @see #setNumTestsPerEvictionRun
      * @see #setDurationBetweenEvictionRuns(Duration)
      */
@@ -1060,7 +1057,6 @@ public final boolean getTestOnBorrow() {
      *         being returned from the {@code borrowObject()} method
      *
      * @see #setTestOnCreate
-     *
      * @since 2.2
      */
     public final boolean getTestOnCreate() {
@@ -1092,7 +1088,6 @@ public final boolean getTestOnReturn() {
      * 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 final boolean getTestWhileIdle() {
      * will be run.
      *
      * @return number of milliseconds to sleep between evictor runs
-     *
      * @see #setDurationBetweenEvictionRuns(Duration)
      * @deprecated Use {@link #getDurationBetweenEvictionRuns()}.
      */
@@ -1227,7 +1221,6 @@ protected void markReturningState(final PooledObject<T> pooledObject) {
      * 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 final void setTestOnBorrow(final boolean testOnBorrow) {
      *                      {@code borrowObject()} method
      *
      * @see #getTestOnCreate
-     *
      * @since 2.2
      */
     public final void setTestOnCreate(final boolean testOnCreate) {

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 boolean getTestOnBorrow() {
      *
      * @see GenericObjectPool#getTestOnCreate()
      * @see GenericKeyedObjectPool#getTestOnCreate()
-     *
      * @since 2.2
      */
     public boolean getTestOnCreate() {
@@ -682,7 +680,6 @@ public void setTestOnBorrow(final boolean testOnBorrow) {
      *
      * @see GenericObjectPool#getTestOnCreate()
      * @see GenericKeyedObjectPool#getTestOnCreate()
-     *
      * @since 2.2
      */
     public void setTestOnCreate(final boolean testOnCreate) {