Class EvictionConfig
java.lang.Object
org.apache.tomcat.dbcp.pool2.impl.EvictionConfig
This class is used by pool implementations to pass configuration information
 to 
EvictionPolicy instances. The EvictionPolicy may also have
 its own specific configuration attributes.
 This class is immutable and thread-safe.
- Since:
- 2.0
- 
Constructor SummaryConstructorsConstructorDescriptionEvictionConfig(long poolIdleEvictTime, long poolIdleSoftEvictTime, int minIdle) Create a new eviction configuration with the specified parameters.
- 
Method SummaryModifier and TypeMethodDescriptionlongObtain theidleEvictTimefor this eviction configuration instance.longObtain theidleSoftEvictTimefor this eviction configuration instance.intObtain theminIdlefor this eviction configuration instance.toString()
- 
Constructor Details- 
EvictionConfigpublic EvictionConfig(long poolIdleEvictTime, long poolIdleSoftEvictTime, int minIdle) Create a new eviction configuration with the specified parameters. Instances are immutable.- Parameters:
- poolIdleEvictTime- Expected to be provided by- BaseGenericObjectPool.getMinEvictableIdleTimeMillis()
- poolIdleSoftEvictTime- Expected to be provided by- BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis()
- minIdle- Expected to be provided by- GenericObjectPool.getMinIdle()or- GenericKeyedObjectPool.getMinIdlePerKey()
 
 
- 
- 
Method Details- 
getIdleEvictTimepublic long getIdleEvictTime()Obtain theidleEvictTimefor this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured EvictionPolicy.- Returns:
- The idleEvictTimein milliseconds
 
- 
getIdleSoftEvictTimepublic long getIdleSoftEvictTime()Obtain theidleSoftEvictTimefor this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured EvictionPolicy.- Returns:
- The (@code idleSoftEvictTime} in milliseconds
 
- 
getMinIdlepublic int getMinIdle()Obtain theminIdlefor this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured EvictionPolicy.- Returns:
- The minIdle
 
- 
toString
 
-