commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r378763 - in /jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool: KeyedObjectPool.java ObjectPool.java
Date Sat, 18 Feb 2006 19:29:35 GMT
Author: rdonkin
Date: Sat Feb 18 11:29:33 2006
New Revision: 378763

URL: http://svn.apache.org/viewcvs?rev=378763&view=rev
Log:
Updates to javadoc contracts for 2.0. Contributed by Sandy McArthur. Issue#38666.

Modified:
    jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java
    jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java

Modified: jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java?rev=378763&r1=378762&r2=378763&view=diff
==============================================================================
--- jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java
(original)
+++ jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java
Sat Feb 18 11:29:33 2006
@@ -127,12 +127,12 @@
      * Returns the number of instances
      * corresponding to the given <i>key</i>
      * currently idle in my pool (optional operation).
-     * Throws {@link UnsupportedOperationException}
+     * Returns a negative value
      * if this information is not available.
      *
      * @param key the key
-     * @return the number of instances corresponding to the given <i>key</i>
currently idle in my pool
-     * @throws UnsupportedOperationException when this implementation doesn't support the
operation
+     * @return the number of instances corresponding to the given <i>key</i>
currently idle in my pool or a negative value if unsupported
+     * @throws UnsupportedOperationException <strong>deprecated</strong>: when
this implementation doesn't support the operation
      */
     int getNumIdle(Object key) throws UnsupportedOperationException;
 
@@ -141,23 +141,23 @@
      * currently borrowed from but not yet returned
      * to my pool corresponding to the
      * given <i>key</i> (optional operation).
-     * Throws {@link UnsupportedOperationException}
+     * Returns a negative value
      * if this information is not available.
      *
      * @param key the key
-     * @return the number of instances corresponding to the given <i>key</i>
currently borrowed in my pool
-     * @throws UnsupportedOperationException when this implementation doesn't support the
operation
+     * @return the number of instances corresponding to the given <i>key</i>
currently borrowed in my pool or a negative value if unsupported
+     * @throws UnsupportedOperationException <strong>deprecated</strong>: when
this implementation doesn't support the operation
      */
     int getNumActive(Object key) throws UnsupportedOperationException;
 
     /**
      * Returns the total number of instances
      * currently idle in my pool (optional operation).
-     * Throws {@link UnsupportedOperationException}
+     * Returns a negative value
      * if this information is not available.
      *
-     * @return the total number of instances currently idle in my pool
-     * @throws UnsupportedOperationException when this implementation doesn't support the
operation
+     * @return the total number of instances currently idle in my pool or a negative value
if unsupported
+     * @throws UnsupportedOperationException <strong>deprecated</strong>: when
this implementation doesn't support the operation
      */
     int getNumIdle() throws UnsupportedOperationException;
 
@@ -165,11 +165,11 @@
      * Returns the total number of instances
      * current borrowed from my pool but not
      * yet returned (optional operation).
-     * Throws {@link UnsupportedOperationException}
+     * Returns a negative value
      * if this information is not available.
      *
-     * @return the total number of instances currently borrowed from my pool
-     * @throws UnsupportedOperationException when this implementation doesn't support the
operation
+     * @return the total number of instances currently borrowed from my pool or a negative
value if unsupported
+     * @throws UnsupportedOperationException <strong>deprecated</strong>: when
this implementation doesn't support the operation
      */
     int getNumActive() throws UnsupportedOperationException;
 

Modified: jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java?rev=378763&r1=378762&r2=378763&view=diff
==============================================================================
--- jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java (original)
+++ jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java Sat
Feb 18 11:29:33 2006
@@ -111,9 +111,10 @@
      * This may be considered an approximation of the number
      * of objects that can be {@link #borrowObject borrowed}
      * without creating any new instances.
+     * Returns a negative value if this information is not available.
      *
-     * @return the number of instances currently idle in my pool
-     * @throws UnsupportedOperationException if this implementation does not support the
operation
+     * @return the number of instances currently idle in my pool or a negative value if unsupported
+     * @throws UnsupportedOperationException <strong>deprecated</strong>: if
this implementation does not support the operation
      */
     int getNumIdle() throws UnsupportedOperationException;
 
@@ -121,9 +122,10 @@
      * Return the number of instances
      * currently borrowed from my pool 
      * (optional operation).
+     * Returns a negative value if this information is not available.
      *
-     * @return the number of instances currently borrowed in my pool
-     * @throws UnsupportedOperationException if this implementation does not support the
operation
+     * @return the number of instances currently borrowed in my pool or a negative value
if unsupported
+     * @throws UnsupportedOperationException <strong>deprecated</strong>: if
this implementation does not support the operation
      */
     int getNumActive() throws UnsupportedOperationException;
 



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message