Author: sebb
Date: Fri May 4 21:35:19 2012
New Revision: 1334193
URL: http://svn.apache.org/viewvc?rev=1334193&view=rev
Log:
Javadoc
Modified:
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
Modified:
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
URL:
http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java?rev=1334193&r1=1334192&r2=1334193&view=diff
==============================================================================
---
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
(original)
+++
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
Fri May 4 21:35:19 2012
@@ -156,6 +156,8 @@ public interface KeyedObjectPool<K,V> {
* this information is not available.
*
* @param key the key to query
+ * @return the number of instances corresponding to the given
+ * <code>key</code> currently idle in this pool.
*/
int getNumIdle(K key);
@@ -165,12 +167,15 @@ public interface KeyedObjectPool<K,V> {
* Returns a negative value if this information is not available.
*
* @param key the key to query
+ * @return the number of instances currently borrowed from but not yet
+ * returned to the pool corresponding to the given <code>key</code>.
= */
int getNumActive(K key);
/**
* Returns the total number of instances currently idle in this pool.
* Returns a negative value if this information is not available.
+ * @return the total number of instances currently idle in this pool.
= */
int getNumIdle();
@@ -178,6 +183,8 @@ public interface KeyedObjectPool<K,V> {
* Returns the total number of instances current borrowed from this pool
but
* not yet returned. Returns a negative value if this information is not
* available.
+ * @return the total number of instances current borrowed from this pool
but
+ * not yet returned.
*/
int getNumActive();
