commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r1531140 - in /commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2: BaseKeyedPooledObjectFactory.java BasePooledObjectFactory.java KeyedObjectPool.java KeyedPooledObjectFactory.java ObjectPool.java PooledObjectFactory.java
Date Thu, 10 Oct 2013 22:38:28 GMT
Author: markt
Date: Thu Oct 10 22:38:28 2013
New Revision: 1531140

URL: http://svn.apache.org/r1531140
Log:
Fix various Javadoc warnings

Modified:
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/ObjectPool.java
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java?rev=1531140&r1=1531139&r2=1531140&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
(original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
Thu Oct 10 22:38:28 2013
@@ -45,7 +45,8 @@ public abstract class BaseKeyedPooledObj
      */
     public abstract V create(K key)
         throws Exception;
-    
+
+    @Override
     public PooledObject<V> makeObject(K key) throws Exception {
         return new DefaultPooledObject<V>(create(key));
     }

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java?rev=1531140&r1=1531139&r2=1531140&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
(original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
Thu Oct 10 22:38:28 2013
@@ -27,8 +27,8 @@ import org.apache.commons.pool2.impl.Def
  *
  * @param <T> Type of element managed in this factory.
  *
- * @see PoolableObjectFactory
- * @see BaseKeyedPoolableObjectFactory
+ * @see PooledObjectFactory
+ * @see BaseKeyedPooledObjectFactory
  *
  * @version $Revision: 1333925 $
  *
@@ -39,11 +39,11 @@ public abstract class BasePooledObjectFa
      * Creates an object instance, to be wrapped in a {@link PooledObject}.
      * <p>This method <strong>must</strong> support concurrent, multi-threaded
      * activation.</p>
-     * 
+     *
      * @return an instance to be served by the pool
      */
     public abstract T create() throws Exception;
-    
+
     @Override
     public PooledObject<T> makeObject() throws Exception {
         return new DefaultPooledObject<T>(create());

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=1531140&r1=1531139&r2=1531140&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
Thu Oct 10 22:38:28 2013
@@ -54,7 +54,7 @@ import java.util.NoSuchElementException;
  * @param <K> The type of keys maintained by this pool.
  * @param <V> Type of element pooled in this pool.
  *
- * @see KeyedPoolableObjectFactory
+ * @see KeyedPooledObjectFactory
  * @see ObjectPool
  * @see org.apache.commons.pool2.impl.GenericKeyedObjectPool GenericKeyedObjectPool
  *
@@ -67,11 +67,11 @@ public interface KeyedObjectPool<K,V> {
      * Obtains an instance from this pool for the specified <code>key</code>.
      * <p>
      * Instances returned from this method will have been either newly created
-     * with {@link KeyedPoolableObjectFactory#makeObject makeObject} or will be
+     * with {@link KeyedPooledObjectFactory#makeObject makeObject} or will be
      * a previously idle object and have been activated with
-     * {@link KeyedPoolableObjectFactory#activateObject activateObject} and then
+     * {@link KeyedPooledObjectFactory#activateObject activateObject} and then
      * (optionally) validated with
-     * {@link KeyedPoolableObjectFactory#validateObject validateObject}.
+     * {@link KeyedPooledObjectFactory#validateObject validateObject}.
      * <p>
      * By contract, clients <strong>must</strong> return the borrowed object
      * using {@link #returnObject returnObject},
@@ -90,7 +90,7 @@ public interface KeyedObjectPool<K,V> {
      * @throws IllegalStateException
      *              after {@link #close close} has been called on this pool
      * @throws Exception
-     *              when {@link KeyedPoolableObjectFactory#makeObject
+     *              when {@link KeyedPooledObjectFactory#makeObject
      *              makeObject} throws an exception
      * @throws NoSuchElementException
      *              when the pool is exhausted and cannot or will not return
@@ -132,7 +132,7 @@ public interface KeyedObjectPool<K,V> {
     void invalidateObject(K key, V obj) throws Exception;
 
     /**
-     * Create an object using the {@link KeyedPoolableObjectFactory factory} or
+     * Create an object using the {@link KeyedPooledObjectFactory factory} or
      * other implementation dependent mechanism, passivate it, and then place it
      * in the idle object pool. <code>addObject</code> is useful for
      * "pre-loading" a pool with idle objects (Optional operation).
@@ -140,7 +140,7 @@ public interface KeyedObjectPool<K,V> {
      * @param key the key a new instance should be added to
      *
      * @throws Exception
-     *              when {@link KeyedPoolableObjectFactory#makeObject} fails.
+     *              when {@link KeyedPooledObjectFactory#makeObject} fails.
      * @throws IllegalStateException
      *              after {@link #close} has been called on this pool.
      * @throws UnsupportedOperationException

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java?rev=1531140&r1=1531139&r2=1531140&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
(original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
Thu Oct 10 22:38:28 2013
@@ -53,7 +53,7 @@ package org.apache.commons.pool2;
  *   be considered active, passive or in a generally consistent state.
  *  </li>
  * </ol>
- * {@link KeyedPoolableObjectFactory} must be thread-safe. The only promise
+ * {@link KeyedPooledObjectFactory} must be thread-safe. The only promise
  * an {@link KeyedObjectPool} makes is that the same instance of an object will
  * not be passed to more than one method of a
  * <code>KeyedPoolableObjectFactory</code> at a time.

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/ObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/ObjectPool.java?rev=1531140&r1=1531139&r2=1531140&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/ObjectPool.java (original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/ObjectPool.java Thu Oct
10 22:38:28 2013
@@ -48,7 +48,7 @@ import java.util.NoSuchElementException;
  *
  * @param <T> Type of element pooled in this pool.
  *
- * @see PoolableObjectFactory
+ * @see PooledObjectFactory
  * @see KeyedObjectPool
  * @see BaseObjectPool
  *
@@ -61,10 +61,10 @@ public interface ObjectPool<T> {
      * Obtains an instance from this pool.
      * <p>
      * Instances returned from this method will have been either newly created
-     * with {@link PoolableObjectFactory#makeObject} or will be a previously
+     * with {@link PooledObjectFactory#makeObject} or will be a previously
      * idle object and have been activated with
-     * {@link PoolableObjectFactory#activateObject} and then validated with
-     * {@link PoolableObjectFactory#validateObject}.
+     * {@link PooledObjectFactory#activateObject} and then validated with
+     * {@link PooledObjectFactory#validateObject}.
      * <p>
      * By contract, clients <strong>must</strong> return the borrowed instance
      * using {@link #returnObject}, {@link #invalidateObject}, or a related
@@ -79,7 +79,7 @@ public interface ObjectPool<T> {
      * @throws IllegalStateException
      *              after {@link #close close} has been called on this pool.
      * @throws Exception
-     *              when {@link PoolableObjectFactory#makeObject} throws an
+     *              when {@link PooledObjectFactory#makeObject} throws an
      *              exception.
      * @throws NoSuchElementException
      *              when the pool is exhausted and cannot or will not return
@@ -116,13 +116,13 @@ public interface ObjectPool<T> {
     void invalidateObject(T obj) throws Exception;
 
     /**
-     * Create an object using the {@link PoolableObjectFactory factory} or other
+     * Create an object using the {@link PooledObjectFactory factory} or other
      * implementation dependent mechanism, passivate it, and then place it in
      * the idle object pool. <code>addObject</code> is useful for "pre-loading"
      * a pool with idle objects. (Optional operation).
      *
      * @throws Exception
-     *              when {@link PoolableObjectFactory#makeObject} fails.
+     *              when {@link PooledObjectFactory#makeObject} fails.
      * @throws IllegalStateException
      *              after {@link #close} has been called on this pool.
      * @throws UnsupportedOperationException
@@ -150,7 +150,7 @@ public interface ObjectPool<T> {
     /**
      * Clears any objects sitting idle in the pool, releasing any associated
      * resources (optional operation). Idle objects cleared must be
-     * {@link PoolableObjectFactory#destroyObject(Object)}.
+     * {@link PooledObjectFactory#destroyObject(PooledObject)}.
      *
      * @throws UnsupportedOperationException
      *              if this implementation does not support the operation

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java?rev=1531140&r1=1531139&r2=1531140&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
(original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
Thu Oct 10 22:38:28 2013
@@ -51,7 +51,7 @@ package org.apache.commons.pool2;
  *   will be considered active, passive or in a generally consistent state.
  *  </li>
  * </ol>
- * {@link PoolableObjectFactory} must be thread-safe. The only promise
+ * {@link PooledObjectFactory} must be thread-safe. The only promise
  * an {@link ObjectPool} makes is that the same instance of an object will not
  * be passed to more than one method of a <code>PoolableObjectFactory</code>
  * at a time.



Mime
View raw message