Skip to content

Commit a76df55

Browse files
committed
Javadoc, drop anachronistic TODO.
1 parent 1cd9669 commit a76df55

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -950,13 +950,13 @@ private void deregister(final K k) {
950950
/**
951951
* Destroy the wrapped, pooled object.
952952
*
953-
* @param key The key associated with the object to destroy.
953+
* @param key The key associated with the object to destroy
954954
* @param toDestroy The wrapped object to be destroyed
955955
* @param always Should the object be destroyed even if it is not currently
956956
* in the set of idle objects for the given key
957-
* @param destroyMode DestroyMode context provided to the factory
957+
* @param destroyMode {@link DestroyMode} context provided to the factory
958958
* @return {@code true} if the object was destroyed, otherwise {@code false}
959-
* @throws Exception If the object destruction failed
959+
* @throws Exception If the factory throws an exception during destruction
960960
*/
961961
private boolean destroy(final K key, final PooledObject<T> toDestroy, final boolean always, final DestroyMode destroyMode) throws Exception {
962962

@@ -1179,8 +1179,6 @@ public void evict() throws Exception {
11791179
}
11801180
}
11811181
underTest.endEvictionTest(idleObjects);
1182-
// TODO - May need to add code here once additional
1183-
// states are used
11841182
}
11851183
}
11861184
}
@@ -1425,7 +1423,7 @@ public void invalidateObject(final K key, final T obj, final DestroyMode destroy
14251423
* to be borrowed) and active (currently borrowed).
14261424
* <p>
14271425
* Note: This is named listAllObjects so it is presented as an operation via
1428-
* JMX. That means it won't be invoked unless the explicitly requested
1426+
* JMX. That means it won't be invoked unless explicitly requested
14291427
* whereas all attributes will be automatically requested when viewing the
14301428
* attributes for an object in a tool like JConsole.
14311429
* </p>
@@ -1678,7 +1676,7 @@ private void reuseCapacity() {
16781676
* <p>
16791677
* Always activates {@link #reuseCapacity()} at least once.
16801678
*
1681-
* @param newCapacity number of new instances to attempt to create.
1679+
* @param newCapacity number of times to call {@link #reuseCapacity()}
16821680
*/
16831681
private void reuseCapacity(final int newCapacity) {
16841682
final int bound = newCapacity < 1 ? 1 : newCapacity;

0 commit comments

Comments
 (0)