Author: psteitz
Date: Tue Dec 22 22:43:42 2009
New Revision: 893333
URL: http://svn.apache.org/viewvc?rev=893333&view=rev
Log:
Fixed error in close javadoc. JIRA: POOL-154.
Modified:
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
commons/proper/pool/trunk/xdocs/changes.xml
Modified:
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
URL:
http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java?rev=893333&r1=893332&r2=893333&view=diff
==============================================================================
---
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
(original)
+++
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
Tue Dec 22 22:43:42 2009
@@ -1711,11 +1711,12 @@
}
/**
- * Closes the keyed object pool. Once the pool is closed, {...@link
#borrowObject(Object)}
+ * <p>Closes the keyed object pool. Once the pool is closed, {...@link
#borrowObject(Object)}
* will fail with IllegalStateException, but {...@link
#returnObject(Object, Object)} and
- * {...@link #invalidateObject(Object, Object)} will continue to work.
This method does not
- * {...@link #clear()} the pool. The method is idempotent - that is, it is
OK to call it on a closed
- * pool.
+ * {...@link #invalidateObject(Object, Object)} will continue to work,
with returned objects
+ * destroyed on return.</p>
+ *
+ * <p>Destroys idle instances in the pool by invoking {...@link
#clear()}.</p>
*
* @throws Exception
*/
Modified:
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
URL:
http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java?rev=893333&r1=893332&r2=893333&view=diff
==============================================================================
---
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
(original)
+++
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Tue Dec 22 22:43:42 2009
@@ -1424,11 +1424,12 @@
}
/**
- * Closes the pool. Once the pool is closed, {...@link #borrowObject()}
+ * <p>Closes the pool. Once the pool is closed, {...@link #borrowObject()}
* will fail with IllegalStateException, but {...@link
#returnObject(Object)} and
- * {...@link #invalidateObject(Object)} will continue to work. This method
does not
- * {...@link #clear()} the pool. The method is idempotent - that is, it is
OK to call it on a closed
- * pool.
+ * {...@link #invalidateObject(Object)} will continue to work, with
returned objects
+ * destroyed on return.</p>
+ *
+ * <p>Destroys idle instances in the pool by invoking {...@link
#clear()}.</p>
*
* @throws Exception
*/
Modified: commons/proper/pool/trunk/xdocs/changes.xml
URL:
http://svn.apache.org/viewvc/commons/proper/pool/trunk/xdocs/changes.xml?rev=893333&r1=893332&r2=893333&view=diff
==============================================================================
--- commons/proper/pool/trunk/xdocs/changes.xml (original)
+++ commons/proper/pool/trunk/xdocs/changes.xml Tue Dec 22 22:43:42 2009
@@ -21,6 +21,10 @@
</properties>
<body>
<release version="1.5.5" date="TBD" description="TBD">
+ <action dev="psteitz" type="fix" issue="POOL-154" due-to="Glen Mazza">
+ Documentation for the close method in GenericObjectPool and
GenericKeyedObjectPool
+ incorrectly states that this method does not clear the pool.
+ </action>
</release>
<release version="1.5.4" date="2009-11-20" description=
"This is a patch release containing a fix for POOL-152, a regression
