Skip to content

Commit 269ed25

Browse files
committed
No need for blank Javadoc lines between Javadoc @ tags
1 parent 4edc3dc commit 269ed25

29 files changed

+0
-121
lines changed

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,8 @@
2828
* </p>
2929
*
3030
* @see KeyedPooledObjectFactory
31-
*
3231
* @param <K> The type of keys managed by this factory.
3332
* @param <V> Type of element managed by this factory.
34-
*
3533
* @since 2.0
3634
*/
3735
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
5553
*
5654
* @param key the key used when constructing the object
5755
* @return an instance that can be served by the pool
58-
*
5956
* @throws Exception if there is a problem creating a new instance,
6057
* this will be propagated to the code requesting an object.
6158
*/

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
* </p>
2626
*
2727
* @param <T> Type of element pooled in this pool.
28-
*
2928
* @since 2.0
3029
*/
3130
public abstract class BaseObjectPool<T> extends BaseObject implements ObjectPool<T> {
@@ -49,7 +48,6 @@ public void addObject() throws Exception {
4948
* closed.
5049
*
5150
* @throws IllegalStateException when this pool has been closed.
52-
*
5351
* @see #isClosed()
5452
*/
5553
protected final void assertOpen() throws IllegalStateException {

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,8 @@
2626
* This class is immutable, and therefore thread-safe
2727
*
2828
* @param <T> Type of element managed in this factory.
29-
*
3029
* @see PooledObjectFactory
3130
* @see BaseKeyedPooledObjectFactory
32-
*
3331
* @since 2.0
3432
*/
3533
public abstract class BasePooledObjectFactory<T> extends BaseObject implements PooledObjectFactory<T> {
@@ -50,7 +48,6 @@ public void activateObject(final PooledObject<T> p) throws Exception {
5048
* invocation.</p>
5149
*
5250
* @return an instance to be served by the pool, not null.
53-
*
5451
* @throws Exception if there is a problem creating a new instance,
5552
* this will be propagated to the code requesting an object.
5653
*/
@@ -85,7 +82,6 @@ public void passivateObject(final PooledObject<T> p) throws Exception {
8582
* Always returns {@code true}.
8683
*
8784
* @param p ignored
88-
*
8985
* @return {@code true}
9086
*/
9187
@Override
@@ -98,7 +94,6 @@ public boolean validateObject(final PooledObject<T> p) {
9894
* {@link PooledObject}.
9995
*
10096
* @param obj the instance to wrap, should not be null.
101-
*
10297
* @return The provided instance, wrapped by a {@link PooledObject}
10398
*/
10499
public abstract PooledObject<T> wrap(T obj);

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@
6666
* @see KeyedPooledObjectFactory
6767
* @see ObjectPool
6868
* @see org.apache.commons.pool2.impl.GenericKeyedObjectPool GenericKeyedObjectPool
69-
*
7069
* @since 2.0
7170
*/
7271
public interface KeyedObjectPool<K, V> extends Closeable {
@@ -78,7 +77,6 @@ public interface KeyedObjectPool<K, V> extends Closeable {
7877
* "pre-loading" a pool with idle objects (Optional operation).
7978
*
8079
* @param key the key a new instance should be added to
81-
*
8280
* @throws Exception
8381
* when {@link KeyedPooledObjectFactory#makeObject} fails.
8482
* @throws IllegalStateException
@@ -161,7 +159,6 @@ default void addObjects(final K key, final int count) throws Exception {
161159
* </p>
162160
*
163161
* @param key the key used to obtain the object
164-
*
165162
* @return an instance from this pool.
166163
*
167164
* @throws IllegalStateException
@@ -190,7 +187,6 @@ default void addObjects(final K key, final int count) throws Exception {
190187
* the given {@code key} (optional operation).
191188
*
192189
* @param key the key to clear
193-
*
194190
* @throws UnsupportedOperationException when this implementation doesn't
195191
* support the operation
196192
*
@@ -280,7 +276,6 @@ default List<K> getKeys() {
280276
*
281277
* @param key the key used to obtain the object
282278
* @param obj a {@link #borrowObject borrowed} instance to be returned.
283-
*
284279
* @throws Exception if the instance cannot be invalidated
285280
*/
286281
void invalidateObject(K key, V obj) throws Exception;
@@ -303,7 +298,6 @@ default List<K> getKeys() {
303298
* @param key the key used to obtain the object
304299
* @param obj a {@link #borrowObject borrowed} instance to be returned.
305300
* @param destroyMode destroy activation context provided to the factory
306-
*
307301
* @throws Exception if the instance cannot be invalidated
308302
* @since 2.9.0
309303
*/
@@ -320,7 +314,6 @@ default void invalidateObject(final K key, final V obj, final DestroyMode destro
320314
*
321315
* @param key the key used to obtain the object
322316
* @param obj a {@link #borrowObject borrowed} instance to be returned.
323-
*
324317
* @throws IllegalStateException
325318
* if an attempt is made to return an object to the pool that
326319
* is in any state other than allocated (i.e. borrowed).

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

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,8 @@
6868
*
6969
* @see KeyedObjectPool
7070
* @see BaseKeyedPooledObjectFactory
71-
*
7271
* @param <K> The type of keys managed by this factory.
7372
* @param <V> Type of element managed by this factory.
74-
*
7573
* @since 2.0
7674
*/
7775
public interface KeyedPooledObjectFactory<K, V> {
@@ -81,7 +79,6 @@ public interface KeyedPooledObjectFactory<K, V> {
8179
*
8280
* @param key the key used when selecting the object
8381
* @param p a {@code PooledObject} wrapping the instance to be activated
84-
*
8582
* @throws Exception if there is a problem activating {@code obj},
8683
* this exception may be swallowed by the pool.
8784
*
@@ -103,7 +100,6 @@ public interface KeyedPooledObjectFactory<K, V> {
103100
*
104101
* @param key the key used when selecting the instance
105102
* @param p a {@code PooledObject} wrapping the instance to be destroyed
106-
*
107103
* @throws Exception should be avoided as it may be swallowed by
108104
* the pool implementation.
109105
*
@@ -118,7 +114,6 @@ public interface KeyedPooledObjectFactory<K, V> {
118114
* @param key the key used when selecting the instance
119115
* @param p a {@code PooledObject} wrapping the instance to be destroyed
120116
* @param destroyMode DestroyMode providing context to the factory
121-
*
122117
* @throws Exception should be avoided as it may be swallowed by
123118
* the pool implementation.
124119
*
@@ -137,7 +132,6 @@ default void destroyObject(final K key, final PooledObject<V> p, final DestroyMo
137132
* wrap it in a {@link PooledObject} to be managed by the pool.
138133
*
139134
* @param key the key used when constructing the object
140-
*
141135
* @return a {@code PooledObject} wrapping an instance that can
142136
* be served by the pool.
143137
*
@@ -151,7 +145,6 @@ default void destroyObject(final K key, final PooledObject<V> p, final DestroyMo
151145
*
152146
* @param key the key used when selecting the object
153147
* @param p a {@code PooledObject} wrapping the instance to be passivated
154-
*
155148
* @throws Exception if there is a problem passivating {@code obj},
156149
* this exception may be swallowed by the pool.
157150
*
@@ -164,7 +157,6 @@ default void destroyObject(final K key, final PooledObject<V> p, final DestroyMo
164157
*
165158
* @param key the key used when selecting the object
166159
* @param p a {@code PooledObject} wrapping the instance to be validated
167-
*
168160
* @return {@code false} if {@code obj} is not valid and should
169161
* be dropped from the pool, {@code true} otherwise.
170162
*/

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@
5555
* @see PooledObjectFactory
5656
* @see KeyedObjectPool
5757
* @see BaseObjectPool
58-
*
5958
* @since 2.0
6059
*/
6160
public interface ObjectPool<T> extends Closeable {
@@ -111,7 +110,6 @@ default void addObjects(final int count) throws Exception {
111110
* </p>
112111
*
113112
* @return an instance from this pool.
114-
*
115113
* @throws IllegalStateException
116114
* after {@link #close close} has been called on this pool.
117115
* @throws Exception
@@ -177,7 +175,6 @@ default void addObjects(final int count) throws Exception {
177175
* </p>
178176
*
179177
* @param obj a {@link #borrowObject borrowed} instance to be disposed.
180-
*
181178
* @throws Exception if the instance cannot be invalidated
182179
*/
183180
void invalidateObject(T obj) throws Exception;
@@ -210,7 +207,6 @@ default void invalidateObject(final T obj, final DestroyMode destroyMode) throws
210207
* a related method as defined in an implementation or sub-interface.
211208
*
212209
* @param obj a {@link #borrowObject borrowed} instance to be returned.
213-
*
214210
* @throws IllegalStateException
215211
* if an attempt is made to return an object to the pool that
216212
* is in any state other than allocated (i.e. borrowed).

src/main/java/org/apache/commons/pool2/PoolUtils.java

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1333,7 +1333,6 @@ static class TimerHolder {
13331333
* keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.
13341334
* @param <K> the type of the pool key
13351335
* @param <V> the type of pool entries
1336-
*
13371336
* @return a {@link Map} of key and {@link TimerTask} pairs that will
13381337
* periodically check the pools idle object count.
13391338
* @throws IllegalArgumentException
@@ -1373,7 +1372,6 @@ public static <K, V> Map<K, TimerTask> checkMinIdle(
13731372
* keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.
13741373
* @param <K> the type of the pool key
13751374
* @param <V> the type of pool entries
1376-
*
13771375
* @return the {@link TimerTask} that will periodically check the pools idle
13781376
* object count.
13791377
* @throws IllegalArgumentException
@@ -1414,7 +1412,6 @@ public static <K, V> TimerTask checkMinIdle(
14141412
* the frequency in milliseconds to check the number of idle objects in a pool,
14151413
* see {@link Timer#schedule(TimerTask, long, long)}.
14161414
* @param <T> the type of objects in the pool
1417-
*
14181415
* @return the {@link TimerTask} that will periodically check the pools idle
14191416
* object count.
14201417
* @throws IllegalArgumentException
@@ -1471,7 +1468,6 @@ public static void checkRethrow(final Throwable t) {
14711468
* count when possible.
14721469
* @param <K> the type of the pool key
14731470
* @param <V> the type of pool entries
1474-
*
14751471
* @throws IllegalArgumentException
14761472
* when {@code keyedPool} is {@code null}.
14771473
* @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,
15061502
* shrinks less aggressively.
15071503
* @param <K> the type of the pool key
15081504
* @param <V> the type of pool entries
1509-
*
15101505
* @throws IllegalArgumentException
15111506
* when {@code keyedPool} is {@code null} or when {@code factor}
15121507
* is not positive.
@@ -1549,7 +1544,6 @@ public static <K, V> KeyedObjectPool<K, V> erodingPool(final KeyedObjectPool<K,
15491544
* when true, each key is treated independently.
15501545
* @param <K> the type of the pool key
15511546
* @param <V> the type of pool entries
1552-
*
15531547
* @throws IllegalArgumentException
15541548
* when {@code keyedPool} is {@code null} or when {@code factor}
15551549
* is not positive.
@@ -1584,7 +1578,6 @@ public static <K, V> KeyedObjectPool<K, V> erodingPool(
15841578
* the ObjectPool to be decorated so it shrinks its idle count
15851579
* when possible.
15861580
* @param <T> the type of objects in the pool
1587-
*
15881581
* @throws IllegalArgumentException
15891582
* when {@code pool} is {@code null}.
15901583
* @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) {
16171610
* shrinks more aggressively. If 1 &lt; factor then the pool
16181611
* shrinks less aggressively.
16191612
* @param <T> the type of objects in the pool
1620-
*
16211613
* @throws IllegalArgumentException
16221614
* when {@code pool} is {@code null} or when {@code factor} is
16231615
* not positive.
@@ -1658,7 +1650,6 @@ private static Timer getMinIdleTimer() {
16581650
* the number of idle objects to add for each {@code key}.
16591651
* @param <K> the type of the pool key
16601652
* @param <V> the type of pool entries
1661-
*
16621653
* @throws Exception
16631654
* when {@link KeyedObjectPool#addObject(Object)} fails.
16641655
* @throws IllegalArgumentException
@@ -1689,7 +1680,6 @@ public static <K, V> void prefill(final KeyedObjectPool<K, V> keyedPool,
16891680
* the number of idle objects to add for {@code key}.
16901681
* @param <K> the type of the pool key
16911682
* @param <V> the type of pool entries
1692-
*
16931683
* @throws Exception
16941684
* when {@link KeyedObjectPool#addObject(Object)} fails.
16951685
* @throws IllegalArgumentException
@@ -1715,7 +1705,6 @@ public static <K, V> void prefill(final KeyedObjectPool<K, V> keyedPool,
17151705
* @param count
17161706
* the number of idle objects to add.
17171707
* @param <T> the type of objects in the pool
1718-
*
17191708
* @throws Exception
17201709
* when {@link ObjectPool#addObject()} fails.
17211710
* @throws IllegalArgumentException
@@ -1764,7 +1753,6 @@ public static <K, V> KeyedPooledObjectFactory<K, V> synchronizedKeyedPooledFacto
17641753
* KeyedObjectPool.
17651754
* @param <K> the type of the pool key
17661755
* @param <V> the type of pool entries
1767-
*
17681756
* @return a synchronized view of the specified KeyedObjectPool.
17691757
*/
17701758
public static <K, V> KeyedObjectPool<K, V> synchronizedPool(final KeyedObjectPool<K, V> keyedPool) {

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@
6565
* </p>
6666
*
6767
* @param <T> Type of element managed in this factory.
68-
*
6968
* @see ObjectPool
7069
*
7170
* @since 2.0
@@ -76,7 +75,6 @@ public interface PooledObjectFactory<T> {
7675
* Reinitializes an instance to be returned by the pool.
7776
*
7877
* @param p a {@code PooledObject} wrapping the instance to be activated
79-
*
8078
* @throws Exception if there is a problem activating {@code obj},
8179
* this exception may be swallowed by the pool.
8280
*
@@ -98,7 +96,6 @@ public interface PooledObjectFactory<T> {
9896
* </p>
9997
*
10098
* @param p a {@code PooledObject} wrapping the instance to be destroyed
101-
*
10299
* @throws Exception should be avoided as it may be swallowed by
103100
* the pool implementation.
104101
*
@@ -113,7 +110,6 @@ public interface PooledObjectFactory<T> {
113110
*
114111
* @param p a {@code PooledObject} wrapping the instance to be destroyed
115112
* @param destroyMode DestroyMode providing context to the factory
116-
*
117113
* @throws Exception should be avoided as it may be swallowed by
118114
* the pool implementation.
119115
*
@@ -132,7 +128,6 @@ default void destroyObject(final PooledObject<T> p, final DestroyMode destroyMod
132128
* {@link PooledObject} to be managed by the pool.
133129
*
134130
* @return a {@code PooledObject} wrapping an instance that can be served by the pool, not null.
135-
*
136131
* @throws Exception if there is a problem creating a new instance,
137132
* this will be propagated to the code requesting an object.
138133
*/
@@ -142,7 +137,6 @@ default void destroyObject(final PooledObject<T> p, final DestroyMode destroyMod
142137
* Uninitializes an instance to be returned to the idle object pool.
143138
*
144139
* @param p a {@code PooledObject} wrapping the instance to be passivated
145-
*
146140
* @throws Exception if there is a problem passivating {@code obj},
147141
* this exception may be swallowed by the pool.
148142
*
@@ -154,7 +148,6 @@ default void destroyObject(final PooledObject<T> p, final DestroyMode destroyMod
154148
* Ensures that the instance is safe to be returned by the pool.
155149
*
156150
* @param p a {@code PooledObject} wrapping the instance to be validated
157-
*
158151
* @return {@code false} if {@code obj} is not valid and should
159152
* be dropped from the pool, {@code true} otherwise.
160153
*/

src/main/java/org/apache/commons/pool2/UsageTracking.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
* more informed decisions and reporting to be made regarding abandoned objects.
2323
*
2424
* @param <T> The type of object provided by the pool.
25-
*
2625
* @since 2.0
2726
*/
2827
public interface UsageTracking<T> {

0 commit comments

Comments
 (0)