You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ps...@apache.org on 2011/12/23 08:17:03 UTC

svn commit: r1222588 - in /commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl: GenericKeyedObjectPool.java GenericObjectPool.java

Author: psteitz
Date: Fri Dec 23 07:17:03 2011
New Revision: 1222588

URL: http://svn.apache.org/viewvc?rev=1222588&view=rev
Log:
Javadoc.

Modified:
    commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
    commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericObjectPool.java

Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java?rev=1222588&r1=1222587&r2=1222588&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java (original)
+++ commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java Fri Dec 23 07:17:03 2011
@@ -763,7 +763,7 @@ public class GenericKeyedObjectPool<K,T>
      * {@link #getBlockWhenExhausted()} is true.</p>
      * 
      * @param key pool key
-     * @param borrowMaxWait
+     * @param borrowMaxWait maximum amount of time to wait (in milliseconds)
      * @return object instance from the keyed pool
      * @throws NoSuchElementException if a keyed object instance cannot be returned.
      */
@@ -993,6 +993,8 @@ public class GenericKeyedObjectPool<K,T>
       * @param key pool key
       * @param obj instance to invalidate
       * @throws Exception if an exception occurs destroying the object
+      * @throws IllegalStateException if obj does not belong to the pool
+      * under the given key
       */
      public void invalidateObject(K key, T obj) throws Exception {
          

Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericObjectPool.java?rev=1222588&r1=1222587&r2=1222588&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericObjectPool.java (original)
+++ commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericObjectPool.java Fri Dec 23 07:17:03 2011
@@ -919,9 +919,9 @@ public class GenericObjectPool<T> extend
      * destroy the instance.
      * </p>
      * 
-     * @throws Exception
-     *             if the configured {@link PoolableObjectFactory} throws an
-     *             exception destroying obj
+     * @throws Exception if the configured {@link PoolableObjectFactory} throws an
+     * exception destroying obj
+     * @throws IllegalStateException if obj does not belong to this pool
      */
     @Override
     public void invalidateObject(T obj) throws Exception {