commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pste...@apache.org
Subject svn commit: r1132516 - /commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericObjectPool.java
Date Mon, 06 Jun 2011 03:02:35 GMT
Author: psteitz
Date: Mon Jun  6 03:02:35 2011
New Revision: 1132516

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

Modified:
    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/GenericObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool2/impl/GenericObjectPool.java?rev=1132516&r1=1132515&r2=1132516&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
Mon Jun  6 03:02:35 2011
@@ -119,10 +119,9 @@ import org.apache.commons.pool2.Poolable
  * <i>softMinEvictableIdleTimeMillis</i>} specifies the minimum amount of time
  * an object may sit idle in the pool before it is eligible for eviction by the
  * idle object evictor (if any), with the extra condition that at least
- * "minIdle" object instances remain in the pool. When non-positive, no objects
- * will be evicted from the pool due to idle time alone. This setting has no
+ * "minIdle" object instances remain in the pool. This setting has no
  * effect unless <code>timeBetweenEvictionRunsMillis > 0.</code> and it is
- * superceded by {@link #setMinEvictableIdleTimeMillis
+ * superseded by {@link #setMinEvictableIdleTimeMillis
  * <i>minEvictableIdleTimeMillis</i>} (that is, if
  * <code>minEvictableIdleTimeMillis</code> is positive, then
  * <code>softMinEvictableIdleTimeMillis</code> is ignored). The default setting
@@ -1056,15 +1055,20 @@ public class GenericObjectPool<T> extend
     }
 
     /**
-     * Returns the minimum amount of time an object may sit idle in the pool
-     * before it is eligible for eviction by the idle object evictor (if any),
-     * with the extra condition that at least "minIdle" amount of object remain
-     * in the pool.
+     * Returns the minimum amount of time
+     * an object may sit idle in the pool before it is eligible for eviction by the
+     * idle object evictor (if any), with the extra condition that at least
+     * "minIdle" object instances remain in the pool. This setting has no
+     * effect unless {@code timeBetweenEvictionRunsMillis > 0.} and it is
+     * superseded by {@link #setMinEvictableIdleTimeMillis
+     * <i>minEvictableIdleTimeMillis</i>} (that is, if
+     * {@code minEvictableIdleTimeMillis} is positive, then
+     * {@code softMinEvictableIdleTimeMillis} is ignored). The default setting
+     * for this parameter is -1 (disabled).
      * 
      * @return minimum amount of time an object may sit idle in the pool before
-     *         it is eligible for eviction.
+     *         it is eligible for eviction if minIdle instances are available
      * @since Pool 1.3
-     * @see #setSoftMinEvictableIdleTimeMillis
      */
     public long getSoftMinEvictableIdleTimeMillis() {
         return _softMinEvictableIdleTimeMillis;



Mime
View raw message