commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1222388 - in /commons/proper/pool/branches/POOL_1_X: ./ src/java/org/apache/commons/pool/ src/java/org/apache/commons/pool/impl/
Date Thu, 22 Dec 2011 18:28:28 GMT
Author: ggregory
Date: Thu Dec 22 18:28:27 2011
New Revision: 1222388

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

Modified:
    commons/proper/pool/branches/POOL_1_X/pom.xml
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPoolFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedPoolableObjectFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPoolFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolUtils.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolableObjectFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPoolFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPoolFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/SoftReferenceObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPoolFactory.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPool.java
    commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPoolFactory.java

Modified: commons/proper/pool/branches/POOL_1_X/pom.xml
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/pom.xml?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/pom.xml (original)
+++ commons/proper/pool/branches/POOL_1_X/pom.xml Thu Dec 22 18:28:27 2011
@@ -22,7 +22,7 @@
   <parent>
     <groupId>org.apache.commons</groupId>
     <artifactId>commons-parent</artifactId>
-    <version>20</version>
+    <version>22</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <groupId>commons-pool</groupId>
@@ -124,15 +124,6 @@
     </dependency>
   </dependencies>
 
-  <distributionManagement>
-    <!-- Cannot define in parent ATM, see COMMONSSITE-26 -->
-    <site>
-      <id>apache.website</id>
-      <name>Apache Commons Site</name>
-      <url>${commons.deployment.protocol}://people.apache.org/www/commons.apache.org/pool</url>
-    </site>
-  </distributionManagement>
-  
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
@@ -144,21 +135,16 @@
     <commons.jira.pid>12310488</commons.jira.pid>
   </properties> 
 
+  <distributionManagement>
+    <!-- Cannot define in parent ATM, see COMMONSSITE-26 -->
+    <site>
+      <id>apache.website</id>
+      <name>Apache Commons Site</name>
+      <url>${commons.deployment.protocol}://people.apache.org/www/commons.apache.org/${commons.componentid}</url>
+    </site>
+  </distributionManagement>
+  
   <build>
-    <pluginManagement>
-      <plugins>
-        <plugin>
-          <!-- Override plugin versions in parent Pom, which are too old to support manifests
-->
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-source-plugin</artifactId>
-          <version>2.1.2</version>
-        </plugin>
-        <plugin>
-          <artifactId>maven-assembly-plugin</artifactId>
-          <version>2.2.2</version>
-        </plugin>
-      </plugins>
-    </pluginManagement>
     <sourceDirectory>src/java</sourceDirectory>
     <testSourceDirectory>src/test</testSourceDirectory>
       <plugins>

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -22,6 +22,9 @@ package org.apache.commons.pool;
  * Optional operations are implemented to either do nothing, return a value
  * indicating it is unsupported or throw {@link UnsupportedOperationException}.
  *
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @author Rodney Waldhoff
  * @author Sandy McArthur
  * @version $Revision$ $Date$

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.java
Thu Dec 22 18:28:27 2011
@@ -23,6 +23,9 @@ package org.apache.commons.pool;
  * All operations defined here are essentially no-op's.
  * </p>
  *
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @see KeyedPoolableObjectFactory
  *
  * @author Rodney Waldhoff

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BaseObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -22,6 +22,8 @@ package org.apache.commons.pool;
  * Optional operations are implemented to either do nothing, return a value
  * indicating it is unsupported or throw {@link UnsupportedOperationException}.
  *
+ * @param <T> the type of objects held in this pool
+ *
  * @author Rodney Waldhoff
  * @author Sandy McArthur
  * @version $Revision$ $Date$

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/BasePoolableObjectFactory.java
Thu Dec 22 18:28:27 2011
@@ -22,6 +22,8 @@ package org.apache.commons.pool;
  * <p>
  * All operations defined here are essentially no-op's.
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @see PoolableObjectFactory
  * @see BaseKeyedPoolableObjectFactory
  *

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -55,6 +55,9 @@ import java.util.NoSuchElementException;
  *
  * <p>See {@link BaseKeyedObjectPool} for a simple base implementation.</p>
  *
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @author Rodney Waldhoff
  * @author Sandy McArthur
  * @version $Revision$ $Date$

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPoolFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPoolFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPoolFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedObjectPoolFactory.java
Thu Dec 22 18:28:27 2011
@@ -20,6 +20,9 @@ package org.apache.commons.pool;
 /**
  * A factory for creating {@link KeyedObjectPool}s.
  *
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @see KeyedObjectPool
  *
  * @author Rodney Waldhoff

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedPoolableObjectFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedPoolableObjectFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedPoolableObjectFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/KeyedPoolableObjectFactory.java
Thu Dec 22 18:28:27 2011
@@ -64,6 +64,9 @@ package org.apache.commons.pool;
  * at a time.
  * </p>
  *
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @see KeyedObjectPool
  *
  * @author Rodney Waldhoff

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -53,6 +53,8 @@ import java.util.NoSuchElementException;
  *
  * <p>See {@link BaseObjectPool} for a simple base implementation.</p>
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @author Rodney Waldhoff
  * @author Sandy McArthur
  * @version $Revision$ $Date$

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPoolFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPoolFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPoolFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/ObjectPoolFactory.java
Thu Dec 22 18:28:27 2011
@@ -20,6 +20,8 @@ package org.apache.commons.pool;
 /**
  * A factory interface for creating {@link ObjectPool}s.
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @see ObjectPool
  *
  * @author Rodney Waldhoff

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolUtils.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolUtils.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolUtils.java
Thu Dec 22 18:28:27 2011
@@ -75,6 +75,7 @@ public final class PoolUtils {
      * needed. This method is the equivalent of calling
      * {@link #adapt(KeyedPoolableObjectFactory, Object) PoolUtils.adapt(aKeyedPoolableObjectFactory,
new Object())}.
      *
+     * @param <V> the type of object
      * @param keyedFactory the {@link KeyedPoolableObjectFactory} to delegate to.
      * @return a {@link PoolableObjectFactory} that delegates to <code>keyedFactory</code>
with an internal key.
      * @throws IllegalArgumentException when <code>keyedFactory</code> is <code>null</code>.
@@ -89,6 +90,8 @@ public final class PoolUtils {
      * Adapt a <code>KeyedPoolableObjectFactory</code> instance to work where
a <code>PoolableObjectFactory</code> is
      * needed using the specified <code>key</code> when delegating.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedFactory the {@link KeyedPoolableObjectFactory} to delegate to.
      * @param key the key to use when delegating.
      * @return a {@link PoolableObjectFactory} that delegates to <code>keyedFactory</code>
with the specified key.
@@ -104,6 +107,8 @@ public final class PoolUtils {
      * Adapt a <code>PoolableObjectFactory</code> instance to work where a <code>KeyedPoolableObjectFactory</code>
is
      * needed. The key is ignored.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param factory the {@link PoolableObjectFactory} to delegate to.
      * @return a {@link KeyedPoolableObjectFactory} that delegates to <code>factory</code>
ignoring the key.
      * @throws IllegalArgumentException when <code>factory</code> is <code>null</code>.
@@ -117,6 +122,7 @@ public final class PoolUtils {
      * Adapt a <code>KeyedObjectPool</code> instance to work where an <code>ObjectPool</code>
is needed. This is the
      * equivalent of calling {@link #adapt(KeyedObjectPool, Object) PoolUtils.adapt(aKeyedObjectPool,
new Object())}.
      *
+     * @param <V> the type of object
      * @param keyedPool the {@link KeyedObjectPool} to delegate to.
      * @return an {@link ObjectPool} that delegates to <code>keyedPool</code>
with an internal key.
      * @throws IllegalArgumentException when <code>keyedPool</code> is <code>null</code>.
@@ -131,6 +137,7 @@ public final class PoolUtils {
      * Adapt a <code>KeyedObjectPool</code> instance to work where an <code>ObjectPool</code>
is needed using the
      * specified <code>key</code> when delegating.
      *
+     * @param <V> the type of object
      * @param keyedPool the {@link KeyedObjectPool} to delegate to.
      * @param key the key to use when delegating.
      * @return an {@link ObjectPool} that delegates to <code>keyedPool</code>
with the specified key.
@@ -146,6 +153,8 @@ public final class PoolUtils {
      * Adapt an <code>ObjectPool</code> to work where an <code>KeyedObjectPool</code>
is needed.
      * The key is ignored.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param pool the {@link ObjectPool} to delegate to.
      * @return a {@link KeyedObjectPool} that delegates to <code>pool</code>
ignoring the key.
      * @throws IllegalArgumentException when <code>pool</code> is <code>null</code>.
@@ -159,6 +168,7 @@ public final class PoolUtils {
      * Wraps an <code>ObjectPool</code> and dynamically checks the type of objects
borrowed and returned to the pool.
      * If an object is passed to the pool that isn't of type <code>type</code>
a {@link ClassCastException} will be thrown.
      *
+     * @param <T> the type of object
      * @param pool the pool to enforce type safety on
      * @param type the class type to enforce.
      * @return an <code>ObjectPool</code> that will only allow objects of <code>type</code>
@@ -178,6 +188,8 @@ public final class PoolUtils {
      * Wraps a <code>KeyedObjectPool</code> and dynamically checks the type of
objects borrowed and returned to the keyedPool.
      * If an object is passed to the keyedPool that isn't of type <code>type</code>
a {@link ClassCastException} will be thrown.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the keyedPool to enforce type safety on
      * @param type the class type to enforce.
      * @return a <code>KeyedObjectPool</code> that will only allow objects of
<code>type</code>
@@ -197,6 +209,7 @@ public final class PoolUtils {
      * Periodically check the idle object count for the pool. At most one idle object will
be added per period.
      * If there is an exception when calling {@link ObjectPool#addObject()} then no more
checks will be performed.
      *
+     * @param <T> the type of object
      * @param pool the pool to check periodically.
      * @param minIdle if the {@link ObjectPool#getNumIdle()} is less than this then add an
idle object.
      * @param period the frequency to check the number of idle objects in a pool, see
@@ -224,6 +237,8 @@ public final class PoolUtils {
      * If there is an exception when calling {@link KeyedObjectPool#addObject(Object)} then
no more checks for that key
      * will be performed.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the keyedPool to check periodically.
      * @param key the key to check the idle count of.
      * @param minIdle if the {@link KeyedObjectPool#getNumIdle(Object)} is less than this
then add an idle object.
@@ -254,6 +269,8 @@ public final class PoolUtils {
      * Periodically check the idle object count for each key in the <code>Collection</code>
<code>keys</code> in the keyedPool.
      * At most one idle object will be added per period.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the keyedPool to check periodically.
      * @param keys a collection of keys to check the idle object count.
      * @param minIdle if the {@link KeyedObjectPool#getNumIdle(Object)} is less than this
then add an idle object.
@@ -283,6 +300,7 @@ public final class PoolUtils {
     /**
      * Call <code>addObject()</code> on <code>pool</code> <code>count</code>
number of times.
      *
+     * @param <T> the type of object
      * @param pool the pool to prefill.
      * @param count the number of idle objects to add.
      * @throws Exception when {@link ObjectPool#addObject()} fails.
@@ -302,6 +320,8 @@ public final class PoolUtils {
      * Call <code>addObject(Object)</code> on <code>keyedPool</code>
with <code>key</code> <code>count</code>
      * number of times.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the keyedPool to prefill.
      * @param key the key to add objects for.
      * @param count the number of idle objects to add for <code>key</code>.
@@ -326,6 +346,8 @@ public final class PoolUtils {
      * <code>count</code> number of times. This has the same effect as calling
      * {@link #prefill(KeyedObjectPool, Object, int)} for each key in the <code>keys</code>
collection.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the keyedPool to prefill.
      * @param keys {@link Collection} of keys to add objects for.
      * @param count the number of idle objects to add for each <code>key</code>.
@@ -355,6 +377,7 @@ public final class PoolUtils {
      * borrowed with another layer of synchronization will cause liveliness issues or a deadlock.
      * </p>
      *
+     * @param <T> the type of object
      * @param pool the ObjectPool to be "wrapped" in a synchronized ObjectPool.
      * @return a synchronized view of the specified ObjectPool.
      * @since Pool 1.3
@@ -386,6 +409,8 @@ public final class PoolUtils {
      * borrowed with another layer of synchronization will cause liveliness issues or a deadlock.
      * </p>
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the KeyedObjectPool to be "wrapped" in a synchronized KeyedObjectPool.
      * @return a synchronized view of the specified KeyedObjectPool.
      * @since Pool 1.3
@@ -408,6 +433,7 @@ public final class PoolUtils {
     /**
      * Returns a synchronized (thread-safe) PoolableObjectFactory backed by the specified
PoolableObjectFactory.
      *
+     * @param <T> the type of object
      * @param factory the PoolableObjectFactory to be "wrapped" in a synchronized PoolableObjectFactory.
      * @return a synchronized view of the specified PoolableObjectFactory.
      * @since Pool 1.3
@@ -419,6 +445,8 @@ public final class PoolUtils {
     /**
      * Returns a synchronized (thread-safe) KeyedPoolableObjectFactory backed by the specified
KeyedPoolableObjectFactory.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedFactory the KeyedPoolableObjectFactory to be "wrapped" in a synchronized
KeyedPoolableObjectFactory.
      * @return a synchronized view of the specified KeyedPoolableObjectFactory.
      * @since Pool 1.3
@@ -433,6 +461,7 @@ public final class PoolUtils {
      * provided by many pool implementations. This is also an effective way to shrink FIFO
ordered
      * pools that experience load spikes.
      *
+     * @param <T> the type of object
      * @param pool the ObjectPool to be decorated so it shrinks it's idle count when possible.
      * @return a pool that adaptively decreases it's size when idle objects are no longer
needed.
      * @see #erodingPool(ObjectPool, float)
@@ -454,6 +483,7 @@ public final class PoolUtils {
      * Values greater than 1 cause the pool to less frequently try to shrink it's size.
      * </p>
      *
+     * @param <T> the type of object
      * @param pool the ObjectPool to be decorated so it shrinks it's idle count when possible.
      * @param factor a positive value to scale the rate at which the pool tries to reduce
it's size.
      * If 0 &lt; factor &lt; 1 then the pool shrinks more aggressively.
@@ -478,6 +508,8 @@ public final class PoolUtils {
      * provided by many pool implementations. This is also an effective way to shrink FIFO
ordered
      * pools that experience load spikes.
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the KeyedObjectPool to be decorated so it shrinks it's idle count
when
      * possible.
      * @return a pool that adaptively decreases it's size when idle objects are no longer
needed.
@@ -501,6 +533,8 @@ public final class PoolUtils {
      * Values greater than 1 cause the pool to less frequently try to shrink it's size.
      * </p>
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the KeyedObjectPool to be decorated so it shrinks it's idle count
when
      * possible.
      * @param factor a positive value to scale the rate at which the pool tries to reduce
it's size.
@@ -532,6 +566,8 @@ public final class PoolUtils {
      * shrink it's size. When perKey is true, each key is shrunk independently.
      * </p>
      *
+     * @param <K> the type of key
+     * @param <V> the type of object
      * @param keyedPool the KeyedObjectPool to be decorated so it shrinks it's idle count
when
      * possible.
      * @param factor a positive value to scale the rate at which the pool tries to reduce
it's size.

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolableObjectFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolableObjectFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolableObjectFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/PoolableObjectFactory.java
Thu Dec 22 18:28:27 2011
@@ -64,6 +64,8 @@ package org.apache.commons.pool;
  * at a time.
  * </p>
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @see ObjectPool
  *
  * @author Rodney Waldhoff

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -193,6 +193,10 @@ import org.apache.commons.pool.PoolUtils
  * ensure that no call to a factory method will occur within a synchronization
  * block. See POOL-125 and DBCP-44 for more information.
  * </p>
+ * 
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @see GenericObjectPool
  * @author Rodney Waldhoff
  * @author Dirk Verbeeck

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPoolFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPoolFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPoolFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPoolFactory.java
Thu Dec 22 18:28:27 2011
@@ -24,6 +24,9 @@ import org.apache.commons.pool.KeyedPool
 /**
  * A factory for creating {@link GenericKeyedObjectPool} instances.
  *
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @see GenericKeyedObjectPool
  * @see KeyedObjectPoolFactory
  *

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -180,6 +180,8 @@ import org.apache.commons.pool.impl.Gene
  * ensure that no call to a factory method will occur within a synchronization
  * block. See POOL-125 and DBCP-44 for more information.
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @see GenericKeyedObjectPool
  * @author Rodney Waldhoff
  * @author Dirk Verbeeck

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPoolFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPoolFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPoolFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/GenericObjectPoolFactory.java
Thu Dec 22 18:28:27 2011
@@ -24,6 +24,8 @@ import org.apache.commons.pool.PoolableO
 /**
  * A factory for creating {@link GenericObjectPool} instances.
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @see GenericObjectPool
  * @see ObjectPoolFactory
  *

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/SoftReferenceObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/SoftReferenceObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/SoftReferenceObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/SoftReferenceObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -34,6 +34,8 @@ import org.apache.commons.pool.PoolUtils
  * A {@link java.lang.ref.SoftReference SoftReference} based
  * {@link ObjectPool}.
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @author Rodney Waldhoff
  * @author Sandy McArthur
  * @version $Revision$ $Date$

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -41,6 +41,9 @@ import java.util.Stack;
  * artificial limits.
  * </p>
  *
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @author Rodney Waldhoff
  * @author Sandy McArthur
  * @version $Revision$ $Date$

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPoolFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPoolFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPoolFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackKeyedObjectPoolFactory.java
Thu Dec 22 18:28:27 2011
@@ -24,6 +24,9 @@ import org.apache.commons.pool.KeyedPool
 /**
  * A factory for creating {@link StackKeyedObjectPool} instances.
  *
+ * @param <K> the type of keys in this pool
+ * @param <V> the type of objects held in this pool
+ * 
  * @see StackKeyedObjectPool
  * @see KeyedObjectPoolFactory
  *

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPool.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPool.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPool.java
Thu Dec 22 18:28:27 2011
@@ -38,6 +38,8 @@ import org.apache.commons.pool.PoolableO
  * re-using <tt>Object</tt>s without introducing
  * artificial limits.
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @author Rodney Waldhoff
  * @author Dirk Verbeeck
  * @author Sandy McArthur

Modified: commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPoolFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPoolFactory.java?rev=1222388&r1=1222387&r2=1222388&view=diff
==============================================================================
--- commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPoolFactory.java
(original)
+++ commons/proper/pool/branches/POOL_1_X/src/java/org/apache/commons/pool/impl/StackObjectPoolFactory.java
Thu Dec 22 18:28:27 2011
@@ -24,6 +24,8 @@ import org.apache.commons.pool.PoolableO
 /**
  * A factory for creating {@link StackObjectPool} instances.
  *
+ * @param <T> the type of objects held in this pool
+ * 
  * @see StackObjectPool
  * @see StackKeyedObjectPoolFactory
  *



Mime
View raw message