commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pste...@apache.org
Subject svn commit: r952048 - in /commons/proper/pool/trunk/src/java/org/apache/commons/pool: KeyedObjectPool.java ObjectPool.java
Date Mon, 07 Jun 2010 01:10:53 GMT
Author: psteitz
Date: Mon Jun  7 01:10:53 2010
New Revision: 952048

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

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

Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java?rev=952048&r1=952047&r2=952048&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java (original)
+++ commons/proper/pool/trunk/src/java/org/apache/commons/pool/KeyedObjectPool.java Mon Jun
 7 01:10:53 2010
@@ -108,17 +108,15 @@ public interface KeyedObjectPool {
     void returnObject(Object key, Object obj) throws Exception;
 
     /**
-     * Invalidates an object from the pool
-     * By contract, <code>obj</code> <strong>must</strong> have been
obtained
-     * using {@link #borrowObject borrowObject}
-     * or a related method as defined in an implementation
-     * or sub-interface
-     * using a <code>key</code> that is equivalent to the one used to
-     * borrow the <code>Object</code> in the first place.
-     * <p>
-     * This method should be used when an object that has been borrowed
-     * is determined (due to an exception or other problem) to be invalid.
-     * </p>
+     * <p>Invalidates an object from the pool.</p>
+     * 
+     * <p>By contract, <code>obj</code> <strong>must</strong>
have been obtained
+     * using {@link #borrowObject borrowObject} or a related method as defined
+     * in an implementation or sub-interface using a <code>key</code> that is
+     * equivalent to the one used to borrow the <code>Object</code> in the first
place.</p>
+     *
+     * <p>This method should be used when an object that has been borrowed
+     * is determined (due to an exception or other problem) to be invalid.</p>
      *
      * @param key the key used to obtain the object
      * @param obj a {@link #borrowObject borrowed} instance to be returned.

Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java?rev=952048&r1=952047&r2=952048&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java (original)
+++ commons/proper/pool/trunk/src/java/org/apache/commons/pool/ObjectPool.java Mon Jun  7
01:10:53 2010
@@ -103,15 +103,14 @@ public interface ObjectPool {
     void returnObject(Object obj) throws Exception;
 
     /**
-     * Invalidates an object from the pool.
-     * By contract, <code>obj</code> <strong>must</strong> have been
obtained
-     * using {@link #borrowObject borrowObject}
-     * or a related method as defined in an implementation
-     * or sub-interface.
-     * <p>
-     * This method should be used when an object that has been borrowed
-     * is determined (due to an exception or other problem) to be invalid.
-     * </p>
+     * <p>Invalidates an object from the pool.</p>
+     * 
+     * <p>By contract, <code>obj</code> <strong>must</strong>
have been obtained
+     * using {@link #borrowObject borrowObject} or a related method as defined in
+     * an implementation or sub-interface.</p>
+     *
+     * <p>This method should be used when an object that has been borrowed
+     * is determined (due to an exception or other problem) to be invalid.</p>
      *
      * @param obj a {@link #borrowObject borrowed} instance to be disposed.
      * @throws Exception



Mime
View raw message