BaseObjectPoolConfig

Provides the implementation for the common attributes shared by the sub-classes. New instances of this class will be created using the defaults defined by the public constants. <p> This class is not thread-safe. </p>

@param <T> Type of element pooled.

abstract

class BaseObjectPoolConfig : BaseObject , Cloneable {

enum bool DEFAULT_LIFO;

enum bool DEFAULT_FAIRNESS;

enum long DEFAULT_MAX_WAIT_MILLIS;

enum long DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS;

enum long DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS;

enum long DEFAULT_EVICTOR_SHUTDOWN_TIMEOUT_MILLIS;

enum int DEFAULT_NUM_TESTS_PER_EVICTION_RUN;

enum bool DEFAULT_TEST_ON_CREATE;

enum bool DEFAULT_TEST_ON_BORROW;

enum bool DEFAULT_TEST_ON_RETURN;

enum bool DEFAULT_TEST_WHILE_IDLE;

enum long DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS;

enum bool DEFAULT_BLOCK_WHEN_EXHAUSTED;

enum bool DEFAULT_JMX_ENABLE;

enum string DEFAULT_JMX_NAME_PREFIX;

enum string DEFAULT_JMX_NAME_BASE;

enum string DEFAULT_EVICTION_POLICY_CLASS_NAME;

bool getLifo();

bool getFairness();

void setLifo(bool lifo);

void setFairness(bool fairness);

long getMaxWaitMillis();

void setMaxWaitMillis(long maxWaitMillis);

long getMinEvictableIdleTimeMillis();

void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis);

long getSoftMinEvictableIdleTimeMillis();

void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis);

int getNumTestsPerEvictionRun();

void setNumTestsPerEvictionRun(int numTestsPerEvictionRun);

long getEvictorShutdownTimeoutMillis();

void setEvictorShutdownTimeoutMillis(long evictorShutdownTimeoutMillis);

bool getTestOnCreate();

void setTestOnCreate(bool testOnCreate);

bool getTestOnBorrow();

void setTestOnBorrow(bool testOnBorrow);

bool getTestOnReturn();

void setTestOnReturn(bool testOnReturn);

bool getTestWhileIdle();

void setTestWhileIdle(bool testWhileIdle);

long getTimeBetweenEvictionRunsMillis();

void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis);

EvictionPolicy getEvictionPolicy();

string getEvictionPolicyClassName();

void setEvictionPolicy(EvictionPolicy evictionPolicy);

void setEvictionPolicyClassName(string evictionPolicyClassName);

bool getBlockWhenExhausted();

void setBlockWhenExhausted(bool blockWhenExhausted);

bool getJmxEnabled();

void setJmxEnabled(bool jmxEnabled);

string getJmxNameBase();

void setJmxNameBase(string jmxNameBase);

string getJmxNamePrefix();

void setJmxNamePrefix(string jmxNamePrefix);

void toStringAppendFields(StringBuilder builder);

mixin CloneMemberTemplate!(typeof(this), TopLevel.yes) ;

}

Members

Functions

getBlockWhenExhausted bool getBlockWhenExhausted(): Get the value for the {@code blockWhenExhausted} configuration attribute for pools created with this configuration instance.
getEvictionPolicy EvictionPolicy getEvictionPolicy(): Get the value for the {@code evictionPolicyClass} configuration attribute for pools created with this configuration instance.
getEvictionPolicyClassName string getEvictionPolicyClassName(): Get the value for the {@code evictionPolicyClassName} configuration attribute for pools created with this configuration instance.
getEvictorShutdownTimeoutMillis long getEvictorShutdownTimeoutMillis(): Get the value for the {@code evictorShutdownTimeoutMillis} configuration attribute for pools created with this configuration instance.
getFairness bool getFairness(): Get the value for the {@code fairness} configuration attribute for pools created with this configuration instance.
getJmxEnabled bool getJmxEnabled(): Gets the value of the flag that determines if JMX will be enabled for pools created with this configuration instance.
getJmxNameBase string getJmxNameBase(): Gets the value of the JMX name base that will be used as part of the name assigned to JMX enabled pools created with this configuration instance. A value of <code>null</code> means that the pool will define the JMX name base.
getJmxNamePrefix string getJmxNamePrefix(): Gets the value of the JMX name prefix that will be used as part of the name assigned to JMX enabled pools created with this configuration instance.
getLifo bool getLifo(): Get the value for the {@code lifo} configuration attribute for pools created with this configuration instance.
getMaxWaitMillis long getMaxWaitMillis(): Get the value for the {@code maxWait} configuration attribute for pools created with this configuration instance.
getMinEvictableIdleTimeMillis long getMinEvictableIdleTimeMillis(): Get the value for the {@code minEvictableIdleTimeMillis} configuration attribute for pools created with this configuration instance.
getNumTestsPerEvictionRun int getNumTestsPerEvictionRun(): Get the value for the {@code numTestsPerEvictionRun} configuration attribute for pools created with this configuration instance.
getSoftMinEvictableIdleTimeMillis long getSoftMinEvictableIdleTimeMillis(): Get the value for the {@code softMinEvictableIdleTimeMillis} configuration attribute for pools created with this configuration instance.
getTestOnBorrow bool getTestOnBorrow(): Get the value for the {@code testOnBorrow} configuration attribute for pools created with this configuration instance.
getTestOnCreate bool getTestOnCreate(): Get the value for the {@code testOnCreate} configuration attribute for pools created with this configuration instance.
getTestOnReturn bool getTestOnReturn(): Get the value for the {@code testOnReturn} configuration attribute for pools created with this configuration instance.
getTestWhileIdle bool getTestWhileIdle(): Get the value for the {@code testWhileIdle} configuration attribute for pools created with this configuration instance.
getTimeBetweenEvictionRunsMillis long getTimeBetweenEvictionRunsMillis(): Get the value for the {@code timeBetweenEvictionRunsMillis} configuration attribute for pools created with this configuration instance.
setBlockWhenExhausted void setBlockWhenExhausted(bool blockWhenExhausted): Set the value for the {@code blockWhenExhausted} configuration attribute for pools created with this configuration instance.
setEvictionPolicy void setEvictionPolicy(EvictionPolicy evictionPolicy): Set the value for the {@code evictionPolicyClass} configuration attribute for pools created with this configuration instance.
setEvictionPolicyClassName void setEvictionPolicyClassName(string evictionPolicyClassName): Set the value for the {@code evictionPolicyClassName} configuration attribute for pools created with this configuration instance.
setEvictorShutdownTimeoutMillis void setEvictorShutdownTimeoutMillis(long evictorShutdownTimeoutMillis): Set the value for the {@code evictorShutdownTimeoutMillis} configuration attribute for pools created with this configuration instance.
setFairness void setFairness(bool fairness): Set the value for the {@code fairness} configuration attribute for pools created with this configuration instance.
setJmxEnabled void setJmxEnabled(bool jmxEnabled): Sets the value of the flag that determines if JMX will be enabled for pools created with this configuration instance.
setJmxNameBase void setJmxNameBase(string jmxNameBase): Sets the value of the JMX name base that will be used as part of the name assigned to JMX enabled pools created with this configuration instance. A value of <code>null</code> means that the pool will define the JMX name base.
setJmxNamePrefix void setJmxNamePrefix(string jmxNamePrefix): Sets the value of the JMX name prefix that will be used as part of the name assigned to JMX enabled pools created with this configuration instance.
setLifo void setLifo(bool lifo): Set the value for the {@code lifo} configuration attribute for pools created with this configuration instance.
setMaxWaitMillis void setMaxWaitMillis(long maxWaitMillis): Set the value for the {@code maxWait} configuration attribute for pools created with this configuration instance.
setMinEvictableIdleTimeMillis void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis): Set the value for the {@code minEvictableIdleTimeMillis} configuration attribute for pools created with this configuration instance.
setNumTestsPerEvictionRun void setNumTestsPerEvictionRun(int numTestsPerEvictionRun): Set the value for the {@code numTestsPerEvictionRun} configuration attribute for pools created with this configuration instance.
setSoftMinEvictableIdleTimeMillis void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis): Set the value for the {@code softMinEvictableIdleTimeMillis} configuration attribute for pools created with this configuration instance.
setTestOnBorrow void setTestOnBorrow(bool testOnBorrow): Set the value for the {@code testOnBorrow} configuration attribute for pools created with this configuration instance.
setTestOnCreate void setTestOnCreate(bool testOnCreate): Set the value for the {@code testOnCreate} configuration attribute for pools created with this configuration instance.
setTestOnReturn void setTestOnReturn(bool testOnReturn): Set the value for the {@code testOnReturn} configuration attribute for pools created with this configuration instance.
setTestWhileIdle void setTestWhileIdle(bool testWhileIdle): Set the value for the {@code testWhileIdle} configuration attribute for pools created with this configuration instance.
setTimeBetweenEvictionRunsMillis void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis): Set the value for the {@code timeBetweenEvictionRunsMillis} configuration attribute for pools created with this configuration instance.
toStringAppendFields void toStringAppendFields(StringBuilder builder): Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous mixin CloneMemberTemplate!(typeof(this), TopLevel.yes): Undocumented in source.

Variables

DEFAULT_BLOCK_WHEN_EXHAUSTED enum bool DEFAULT_BLOCK_WHEN_EXHAUSTED;: The default value for the {@code blockWhenExhausted} configuration attribute. @see GenericObjectPool#getBlockWhenExhausted() @see GenericKeyedObjectPool#getBlockWhenExhausted()
DEFAULT_EVICTION_POLICY_CLASS_NAME enum string DEFAULT_EVICTION_POLICY_CLASS_NAME;: The default value for the {@code evictionPolicyClassName} configuration attribute. @see GenericObjectPool#getEvictionPolicyClassName() @see GenericKeyedObjectPool#getEvictionPolicyClassName()
DEFAULT_EVICTOR_SHUTDOWN_TIMEOUT_MILLIS enum long DEFAULT_EVICTOR_SHUTDOWN_TIMEOUT_MILLIS;: The default value for {@code evictorShutdownTimeoutMillis} configuration attribute. @see GenericObjectPool#getEvictorShutdownTimeoutMillis() @see GenericKeyedObjectPool#getEvictorShutdownTimeoutMillis()
DEFAULT_FAIRNESS enum bool DEFAULT_FAIRNESS;: The default value for the {@code fairness} configuration attribute. @see GenericObjectPool#getFairness() @see GenericKeyedObjectPool#getFairness()
DEFAULT_JMX_ENABLE enum bool DEFAULT_JMX_ENABLE;: The default value for enabling JMX for pools created with a configuration instance.
DEFAULT_JMX_NAME_BASE enum string DEFAULT_JMX_NAME_BASE;: The default value for the base name to use to name JMX enabled pools created with a configuration instance. The default is <code>null</code> which means the pool will provide the base name to use. @see GenericObjectPool#getJmxName() @see GenericKeyedObjectPool#getJmxName()
DEFAULT_JMX_NAME_PREFIX enum string DEFAULT_JMX_NAME_PREFIX;: The default value for the prefix used to name JMX enabled pools created with a configuration instance. @see GenericObjectPool#getJmxName() @see GenericKeyedObjectPool#getJmxName()
DEFAULT_LIFO enum bool DEFAULT_LIFO;: The default value for the {@code lifo} configuration attribute. @see GenericObjectPool#getLifo() @see GenericKeyedObjectPool#getLifo()
DEFAULT_MAX_WAIT_MILLIS enum long DEFAULT_MAX_WAIT_MILLIS;: The default value for the {@code maxWait} configuration attribute. @see GenericObjectPool#getMaxWaitMillis() @see GenericKeyedObjectPool#getMaxWaitMillis()
DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS enum long DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS;: The default value for the {@code minEvictableIdleTimeMillis} configuration attribute. @see GenericObjectPool#getMinEvictableIdleTimeMillis() @see GenericKeyedObjectPool#getMinEvictableIdleTimeMillis()
DEFAULT_NUM_TESTS_PER_EVICTION_RUN enum int DEFAULT_NUM_TESTS_PER_EVICTION_RUN;: The default value for the {@code numTestsPerEvictionRun} configuration attribute. @see GenericObjectPool#getNumTestsPerEvictionRun() @see GenericKeyedObjectPool#getNumTestsPerEvictionRun()
DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS enum long DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS;: The default value for the {@code softMinEvictableIdleTimeMillis} configuration attribute. @see GenericObjectPool#getSoftMinEvictableIdleTimeMillis() @see GenericKeyedObjectPool#getSoftMinEvictableIdleTimeMillis()
DEFAULT_TEST_ON_BORROW enum bool DEFAULT_TEST_ON_BORROW;: The default value for the {@code testOnBorrow} configuration attribute. @see GenericObjectPool#getTestOnBorrow() @see GenericKeyedObjectPool#getTestOnBorrow()
DEFAULT_TEST_ON_CREATE enum bool DEFAULT_TEST_ON_CREATE;: The default value for the {@code testOnCreate} configuration attribute. @see GenericObjectPool#getTestOnCreate() @see GenericKeyedObjectPool#getTestOnCreate()
DEFAULT_TEST_ON_RETURN enum bool DEFAULT_TEST_ON_RETURN;: The default value for the {@code testOnReturn} configuration attribute. @see GenericObjectPool#getTestOnReturn() @see GenericKeyedObjectPool#getTestOnReturn()
DEFAULT_TEST_WHILE_IDLE enum bool DEFAULT_TEST_WHILE_IDLE;: The default value for the {@code testWhileIdle} configuration attribute. @see GenericObjectPool#getTestWhileIdle() @see GenericKeyedObjectPool#getTestWhileIdle()
DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS enum long DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS;: The default value for the {@code timeBetweenEvictionRunsMillis} configuration attribute. @see GenericObjectPool#getTimeBetweenEvictionRunsMillis() @see GenericKeyedObjectPool#getTimeBetweenEvictionRunsMillis()

Inherited Members

From BaseObject

toString string toString(): Undocumented in source. Be warned that the author may not have intended to support it.
toStringAppendFields void toStringAppendFields(StringBuilder builder): Used by sub-classes to include the fields defined by the sub-class in the {@link #toString()} output.

Meta

Source

See Implementation

hunt pool impl BaseObjectPoolConfig classes

BaseObjectPoolConfig