org.apache.commons.pool2.impl
Class GenericKeyedObjectPoolConfig

java.lang.Object
  extended by org.apache.commons.pool2.impl.BaseObjectPoolConfig
      extended by org.apache.commons.pool2.impl.GenericKeyedObjectPoolConfig
All Implemented Interfaces:
Cloneable

public class GenericKeyedObjectPoolConfig
extends BaseObjectPoolConfig

A simple "struct" encapsulating the configuration for a GenericKeyedObjectPool.

This class is not thread-safe; it is only intended to be used to provide attributes used when creating a pool.

Since:
2.0
Version:
$Revision: $

Field Summary
static int DEFAULT_MAX_IDLE_PER_KEY
          The default value for the minIdlePerKey configuration attribute.
static int DEFAULT_MAX_TOTAL
          The default value for the maxTotal configuration attribute.
static int DEFAULT_MAX_TOTAL_PER_KEY
          The default value for the maxTotalPerKey configuration attribute.
static int DEFAULT_MIN_IDLE_PER_KEY
          The default value for the minIdlePerKey configuration attribute.
 
Fields inherited from class org.apache.commons.pool2.impl.BaseObjectPoolConfig
DEFAULT_BLOCK_WHEN_EXHAUSTED, DEFAULT_EVICTION_POLICY_CLASS_NAME, DEFAULT_JMX_ENABLE, DEFAULT_JMX_NAME_PREFIX, DEFAULT_LIFO, DEFAULT_MAX_WAIT_MILLIS, DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS, DEFAULT_NUM_TESTS_PER_EVICTION_RUN, DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS, DEFAULT_TEST_ON_BORROW, DEFAULT_TEST_ON_RETURN, DEFAULT_TEST_WHILE_IDLE, DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS
 
Constructor Summary
GenericKeyedObjectPoolConfig()
          Create a new configuration with default settings.
 
Method Summary
 GenericKeyedObjectPoolConfig clone()
           
 int getMaxIdlePerKey()
          Get the value for the maxIdlePerKey configuration attribute for pools created with this configuration instance.
 int getMaxTotal()
          Get the value for the maxTotal configuration attribute for pools created with this configuration instance.
 int getMaxTotalPerKey()
          Get the value for the maxTotalPerKey configuration attribute for pools created with this configuration instance.
 int getMinIdlePerKey()
          Get the value for the minIdlePerKey configuration attribute for pools created with this configuration instance.
 void setMaxIdlePerKey(int maxIdlePerKey)
          Set the value for the maxIdlePerKey configuration attribute for pools created with this configuration instance.
 void setMaxTotal(int maxTotal)
          Set the value for the maxTotal configuration attribute for pools created with this configuration instance.
 void setMaxTotalPerKey(int maxTotalPerKey)
          Set the value for the maxTotalPerKey configuration attribute for pools created with this configuration instance.
 void setMinIdlePerKey(int minIdlePerKey)
          Set the value for the minIdlePerKey configuration attribute for pools created with this configuration instance.
 
Methods inherited from class org.apache.commons.pool2.impl.BaseObjectPoolConfig
getBlockWhenExhausted, getEvictionPolicyClassName, getJmxEnabled, getJmxNamePrefix, getLifo, getMaxWaitMillis, getMinEvictableIdleTimeMillis, getNumTestsPerEvictionRun, getSoftMinEvictableIdleTimeMillis, getTestOnBorrow, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, setBlockWhenExhausted, setEvictionPolicyClassName, setJmxEnabled, setJmxNamePrefix, setLifo, setMaxWaitMillis, setMinEvictableIdleTimeMillis, setNumTestsPerEvictionRun, setSoftMinEvictableIdleTimeMillis, setTestOnBorrow, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_MAX_TOTAL_PER_KEY

public static final int DEFAULT_MAX_TOTAL_PER_KEY
The default value for the maxTotalPerKey configuration attribute.

See Also:
GenericKeyedObjectPool.getMaxTotalPerKey(), Constant Field Values

DEFAULT_MAX_TOTAL

public static final int DEFAULT_MAX_TOTAL
The default value for the maxTotal configuration attribute.

See Also:
BaseGenericObjectPool.getMaxTotal(), Constant Field Values

DEFAULT_MIN_IDLE_PER_KEY

public static final int DEFAULT_MIN_IDLE_PER_KEY
The default value for the minIdlePerKey configuration attribute.

See Also:
GenericKeyedObjectPool.getMinIdlePerKey(), Constant Field Values

DEFAULT_MAX_IDLE_PER_KEY

public static final int DEFAULT_MAX_IDLE_PER_KEY
The default value for the minIdlePerKey configuration attribute.

See Also:
GenericKeyedObjectPool.getMaxIdlePerKey(), Constant Field Values
Constructor Detail

GenericKeyedObjectPoolConfig

public GenericKeyedObjectPoolConfig()
Create a new configuration with default settings.

Method Detail

getMaxTotal

public int getMaxTotal()
Get the value for the maxTotal configuration attribute for pools created with this configuration instance.

Returns:
The current setting of maxTotal for this configuration instance
See Also:
BaseGenericObjectPool.getMaxTotal()

setMaxTotal

public void setMaxTotal(int maxTotal)
Set the value for the maxTotal configuration attribute for pools created with this configuration instance.

Parameters:
maxTotal - The new setting of maxTotal for this configuration instance
See Also:
BaseGenericObjectPool.setMaxTotal(int)

getMaxTotalPerKey

public int getMaxTotalPerKey()
Get the value for the maxTotalPerKey configuration attribute for pools created with this configuration instance.

Returns:
The current setting of maxTotalPerKey for this configuration instance
See Also:
GenericKeyedObjectPool.getMaxTotalPerKey()

setMaxTotalPerKey

public void setMaxTotalPerKey(int maxTotalPerKey)
Set the value for the maxTotalPerKey configuration attribute for pools created with this configuration instance.

Parameters:
maxTotalPerKey - The new setting of maxTotalPerKey for this configuration instance
See Also:
GenericKeyedObjectPool.setMaxTotalPerKey(int)

getMinIdlePerKey

public int getMinIdlePerKey()
Get the value for the minIdlePerKey configuration attribute for pools created with this configuration instance.

Returns:
The current setting of minIdlePerKey for this configuration instance
See Also:
GenericKeyedObjectPool.getMinIdlePerKey()

setMinIdlePerKey

public void setMinIdlePerKey(int minIdlePerKey)
Set the value for the minIdlePerKey configuration attribute for pools created with this configuration instance.

Parameters:
minIdlePerKey - The new setting of minIdlePerKey for this configuration instance
See Also:
GenericKeyedObjectPool.setMinIdlePerKey(int)

getMaxIdlePerKey

public int getMaxIdlePerKey()
Get the value for the maxIdlePerKey configuration attribute for pools created with this configuration instance.

Returns:
The current setting of maxIdlePerKey for this configuration instance
See Also:
GenericKeyedObjectPool.getMaxIdlePerKey()

setMaxIdlePerKey

public void setMaxIdlePerKey(int maxIdlePerKey)
Set the value for the maxIdlePerKey configuration attribute for pools created with this configuration instance.

Parameters:
maxIdlePerKey - The new setting of maxIdlePerKey for this configuration instance
See Also:
GenericKeyedObjectPool.setMaxIdlePerKey(int)

clone

public GenericKeyedObjectPoolConfig clone()
Overrides:
clone in class Object


Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.