svn commit: r1533030 - /commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java

[ma...@apache.org]

Author: markt
Date: Thu Oct 17 10:04:25 2013
New Revision: 1533030

URL: http://svn.apache.org/r1533030
Log:
More Javadoc

Modified:
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java?rev=1533030&r1=1533029&r2=1533030&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java (original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/EvictionConfig.java Thu Oct 17 10:04:25 2013
@@ -34,6 +34,18 @@ public class EvictionConfig {
     private final int minIdle;
 
 
+    /**
+     * Create a new eviction configuration with the specified parameters.
+     * Instances are immutable.
+     *
+     * @param poolIdleEvictTime Expected to be provided by
+     *        {@link BaseGenericObjectPool#getMinEvictableIdleTimeMillis()}
+     * @param poolIdleSoftEvictTime Expected to be provided by
+     *        {@link BaseGenericObjectPool#getSoftMinEvictableIdleTimeMillis()}
+     * @param minIdle Expected to be provided by
+     *        {@link GenericObjectPool#getMinIdle()} or
+     *        {@link GenericKeyedObjectPool#getMinIdlePerKey()}
+     */
     public EvictionConfig(long poolIdleEvictTime, long poolIdleSoftEvictTime,
             int minIdle) {
         if (poolIdleEvictTime > 0) {
@@ -49,14 +61,40 @@ public class EvictionConfig {
         this.minIdle = minIdle;
     }
 
+    /**
+     * Obtain the {@code idleEvictTime} for this eviction configuration
+     * instance.
+     * <p>
+     * How the evictor behaves based on this value will be determined by the
+     * configured {@link EvictionPolicy}.
+     *
+     * @return The {@code idleEvictTime} in milliseconds
+     */
     public long getIdleEvictTime() {
         return idleEvictTime;
     }
 
+    /**
+     * Obtain the {@code idleSoftEvictTime} for this eviction configuration
+     * instance.
+     * <p>
+     * How the evictor behaves based on this value will be determined by the
+     * configured {@link EvictionPolicy}.
+     *
+     * @return The (@code idleSoftEvictTime} in milliseconds
+     */
     public long getIdleSoftEvictTime() {
         return idleSoftEvictTime;
     }
 
+    /**
+     * Obtain the {@code minIdle} for this eviction configuration instance.
+     * <p>
+     * How the evictor behaves based on this value will be determined by the
+     * configured {@link EvictionPolicy}.
+     *
+     * @return The {@code minIdle}
+     */
     public int getMinIdle() {
         return minIdle;
     }