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/06/04 17:56:01 UTC
svn commit: r1131419 - in
/commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl:
BaseObjectPoolConfig.java GenericKeyedObjectPool.java GenericObjectPool.java
Author: psteitz
Date: Sat Jun 4 15:56:00 2011
New Revision: 1131419
URL: http://svn.apache.org/viewvc?rev=1131419&view=rev
Log:
Javadoc fixes.
Modified:
commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
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/BaseObjectPoolConfig.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java?rev=1131419&r1=1131418&r2=1131419&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java (original)
+++ commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java Sat Jun 4 15:56:00 2011
@@ -38,9 +38,9 @@ public abstract class BaseObjectPoolConf
/**
* The default maximum amount of time (in milliseconds) the
- * {@link #borrowObject} method should block before throwing an exception
+ * {@code borrowObject} method should block before throwing an exception
* when the pool is exhausted and the {@link #getWhenExhaustedAction
- * "when exhausted" action} is {@link #WHEN_EXHAUSTED_BLOCK}.
+ * "when exhausted" action} is {@link WhenExhaustedAction#BLOCK}.
*/
public static final long DEFAULT_MAX_WAIT = -1L;
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=1131419&r1=1131418&r2=1131419&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 Sat Jun 4 15:56:00 2011
@@ -84,18 +84,12 @@ import org.apache.commons.pool2.PoolUtil
* <ul>
* <li>
* When {@link #setWhenExhaustedAction whenExhaustedAction} is
- * {@link #WHEN_EXHAUSTED_FAIL}, {@link #borrowObject borrowObject} will throw
+ * {@link WhenExhaustedAction#FAIL}, {@link #borrowObject borrowObject} will throw
* a {@link NoSuchElementException}
* </li>
* <li>
- * When {@link #setWhenExhaustedAction whenExhaustedAction} is
- * {@link #WHEN_EXHAUSTED_GROW}, {@link #borrowObject borrowObject} will create a new
- * object and return it (essentially making {@link #setMaxTotalPerKey maxTotalPerKey}
- * meaningless.)
- * </li>
- * <li>
* When {@link #setWhenExhaustedAction whenExhaustedAction}
- * is {@link #WHEN_EXHAUSTED_BLOCK}, {@link #borrowObject borrowObject} will block
+ * is {@link WhenExhaustedAction#BLOCK}, {@link #borrowObject borrowObject} will block
* (invoke {@link Object#wait() wait} until a new or idle object is available.
* If a positive {@link #setMaxWait maxWait}
* value is supplied, the {@link #borrowObject borrowObject} will block for at
@@ -105,7 +99,7 @@ import org.apache.commons.pool2.PoolUtil
* </li>
* </ul>
* The default <code>whenExhaustedAction</code> setting is
- * {@link #WHEN_EXHAUSTED_BLOCK}.
+ * {@link WhenExhaustedAction#BLOCK}.
* </li>
* <li>
* When {@link #setTestOnBorrow testOnBorrow} is set, the pool will
@@ -318,7 +312,7 @@ public class GenericKeyedObjectPool<K,T>
* is invoked when the pool is exhausted (the maximum number
* of "active" objects has been reached).
*
- * @param the action to take when exhausted
+ * @param whenExhaustedAction the action to take when exhausted
* @see #getWhenExhaustedAction
*/
public void setWhenExhaustedAction(WhenExhaustedAction whenExhaustedAction) {
@@ -331,7 +325,7 @@ public class GenericKeyedObjectPool<K,T>
* {@link #borrowObject} method should block before throwing
* an exception when the pool is exhausted and the
* {@link #setWhenExhaustedAction "when exhausted" action} is
- * {@link #WHEN_EXHAUSTED_BLOCK}.
+ * {@link WhenExhaustedAction#BLOCK}.
*
* When less than or equal to 0, the {@link #borrowObject} method
* may block indefinitely.
@@ -339,7 +333,7 @@ public class GenericKeyedObjectPool<K,T>
* @return the maximum number of milliseconds borrowObject will block.
* @see #setMaxWait
* @see #setWhenExhaustedAction
- * @see #WHEN_EXHAUSTED_BLOCK
+ * @see WhenExhaustedAction#BLOCK
*/
public long getMaxWait() {
return _maxWait;
@@ -350,7 +344,7 @@ public class GenericKeyedObjectPool<K,T>
* {@link #borrowObject} method should block before throwing
* an exception when the pool is exhausted and the
* {@link #setWhenExhaustedAction "when exhausted" action} is
- * {@link #WHEN_EXHAUSTED_BLOCK}.
+ * {@link WhenExhaustedAction#BLOCK}.
*
* When less than or equal to 0, the {@link #borrowObject} method
* may block indefinitely.
@@ -358,7 +352,7 @@ public class GenericKeyedObjectPool<K,T>
* @param maxWait the maximum number of milliseconds borrowObject will block or negative for indefinitely.
* @see #getMaxWait
* @see #setWhenExhaustedAction
- * @see #WHEN_EXHAUSTED_BLOCK
+ * @see WhenExhaustedAction#BLOCK
*/
public void setMaxWait(long maxWait) {
_maxWait = maxWait;
@@ -386,7 +380,7 @@ public class GenericKeyedObjectPool<K,T>
* @param maxIdle the maximum number of "idle" instances that can be held
* in a given keyed pool. Use a negative value for no limit.
* @see #getMaxIdle
- * @see #DEFAULT_MAX_IDLE
+ * @see BaseObjectPoolConfig#DEFAULT_MAX_IDLE
*/
public void setMaxIdle(int maxIdle) {
_maxIdle = maxIdle;
@@ -595,7 +589,7 @@ public class GenericKeyedObjectPool<K,T>
/**
* Sets the configuration.
* @param conf the new configuration to use.
- * @see GenericKeyedObjectPool.Config
+ * @see GenericKeyedObjectPoolConfig
*/
public void setConfig(GenericKeyedObjectPoolConfig<K,T> conf) {
setMaxIdle(conf.getMaxIdle());
@@ -660,8 +654,8 @@ public class GenericKeyedObjectPool<K,T>
* is created, activated and (if applicable) validated and returned to the caller.</p>
*
* <p>If the associated keyed pool is exhausted (no available idle instances and no capacity to create new ones),
- * this method will either block ({@link #WHEN_EXHAUSTED_BLOCK}), throw a <code>NoSuchElementException</code>
- * ({@link #WHEN_EXHAUSTED_FAIL}), or grow ({@link #WHEN_EXHAUSTED_GROW} - ignoring maxTotalPerKey, maxTotal properties).
+ * this method will either block ({@link WhenExhaustedAction#BLOCK}) or throw a <code>NoSuchElementException</code>
+ * ({@link WhenExhaustedAction#FAIL}).
* The length of time that this method will block when <code>whenExhaustedAction == WHEN_EXHAUSTED_BLOCK</code>
* is determined by the {@link #getMaxWait() maxWait} property.</p>
*
@@ -794,7 +788,7 @@ public class GenericKeyedObjectPool<K,T>
* to the idle instance pool under the given key. In this case, if validation fails, the instance is destroyed.</p>
*
* @param key pool key
- * @param obj instance to return to the keyed pool
+ * @param t instance to return to the keyed pool
* @throws Exception
*/
@Override
@@ -1632,14 +1626,14 @@ public class GenericKeyedObjectPool<K,T>
* {@link #borrowObject} method should block before throwing
* an exception when the pool is exhausted and the
* {@link #getWhenExhaustedAction "when exhausted" action} is
- * {@link #WHEN_EXHAUSTED_BLOCK}.
+ * {@link WhenExhaustedAction#BLOCK}.
*
* When less than or equal to 0, the {@link #borrowObject} method
* may block indefinitely.
*
* @see #setMaxWait
* @see #getMaxWait
- * @see #WHEN_EXHAUSTED_BLOCK
+ * @see WhenExhaustedAction#BLOCK
* @see #setWhenExhaustedAction
* @see #getWhenExhaustedAction
*/
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=1131419&r1=1131418&r2=1131419&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 Sat Jun 4 15:56:00 2011
@@ -56,14 +56,10 @@ import org.apache.commons.pool2.Poolable
* behavior of the {@link #borrowObject} method when the pool is exhausted:
* <ul>
* <li>When {@link #setWhenExhaustedAction <i>whenExhaustedAction</i>} is
- * {@link #WHEN_EXHAUSTED_FAIL}, {@link #borrowObject} will throw a
+ * {@link WhenExhaustedAction#FAIL}, {@link #borrowObject} will throw a
* {@link NoSuchElementException}</li>
* <li>When {@link #setWhenExhaustedAction <i>whenExhaustedAction</i>} is
- * {@link #WHEN_EXHAUSTED_GROW}, {@link #borrowObject} will create a new object
- * and return it (essentially making {@link #setMaxActive <i>maxActive</i>}
- * meaningless.)</li>
- * <li>When {@link #setWhenExhaustedAction <i>whenExhaustedAction</i>} is
- * {@link #WHEN_EXHAUSTED_BLOCK}, {@link #borrowObject} will block (invoke
+ * {@link WhenExhaustedAction#BLOCK}, {@link #borrowObject} will block (invoke
* {@link Object#wait()}) until a new or idle object is available. If a positive
* {@link #setMaxWait <i>maxWait</i>} value is supplied, then
* {@link #borrowObject} will block for at most that many milliseconds, after
@@ -72,7 +68,7 @@ import org.apache.commons.pool2.Poolable
* indefinitely.</li>
* </ul>
* The default <code>whenExhaustedAction</code> setting is
- * {@link #WHEN_EXHAUSTED_BLOCK} and the default <code>maxWait</code> setting is
+ * {@link WhenExhaustedAction#BLOCK} and the default <code>maxWait</code> setting is
* -1. By default, therefore, <code>borrowObject</code> will block indefinitely
* until an idle instance becomes available.</li>
* <li>When {@link #setTestOnBorrow <i>testOnBorrow</i>} is set, the pool will