Apache Commons Pool 2.13.0 · org.apache.commons.pool2.impl.GenericKeyedObjectPoolConfig

Modifier and Type	Field and Description
public static final int	DEFAULT_MAX_IDLE_PER_KEY The default value for the `maxIdlePerKey` configuration attribute: .
public static final int	DEFAULT_MAX_TOTAL The default value for the `maxTotal` configuration attribute: .
public static final int	DEFAULT_MAX_TOTAL_PER_KEY The default value for the `maxTotalPerKey` configuration attribute: .
public static final int	DEFAULT_MIN_IDLE_PER_KEY The default value for the `minIdlePerKey` configuration attribute: .
public static final boolean	DEFAULT_REUSE_CAPACITY_ON_MAINTENANCE The default value for the `reuseCapacityOnMaintenance` configuration attribute: .
public static final boolean	DEFAULT_REUSE_CAPACITY_ON_RETURN The default value for the `reuseCapacityOnReturn` configuration attribute: .
private int	maxIdlePerKey
private int	maxTotal
private int	maxTotalPerKey
private int	minIdlePerKey
private boolean	reuseCapacityOnMaintenance
private boolean	reuseCapacityOnReturn

Access	Constructor and Description
public	GenericKeyedObjectPoolConfig() Constructs a new configuration with default settings.

Method Summary

Modifier and Type	Method and Description
public GenericKeyedObjectPoolConfig<T>	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public int	Returns: The current setting of `maxIdlePerKey` for this configuration instance getMaxIdlePerKey() Gets the value for the `maxIdlePerKey` configuration attribute for pools created with this configuration instance.
public int	Returns: The current setting of `maxTotal` for this configuration instance getMaxTotal() Gets the value for the `maxTotal` configuration attribute for pools created with this configuration instance.
public int	Returns: The current setting of `maxTotalPerKey` for this configuration instance getMaxTotalPerKey() Gets the value for the `maxTotalPerKey` configuration attribute for pools created with this configuration instance.
public int	Returns: The current setting of `minIdlePerKey` for this configuration instance getMinIdlePerKey() Gets the value for the `minIdlePerKey` configuration attribute for pools created with this configuration instance.
public boolean	Returns: The current setting of `reuseCapacityOnMaintenance` for this configuration instance getReuseCapacityOnMaintenance() Gets the value for the `reuseCapacityOnMaintenance` configuration attribute for pools created with this configuration instance.
public boolean	Returns: The current setting of `reuseCapacityOnReturn` for this configuration instance getReuseCapacityOnReturn() Gets the value for the `reuseCapacityOnReturn` configuration attribute for pools created with this configuration instance.
public void	setMaxIdlePerKey(final int The new setting of `maxIdlePerKey` for this configuration instance maxIdlePerKey) Sets the value for the `maxIdlePerKey` configuration attribute for pools created with this configuration instance.
public void	setMaxTotal(final int The new setting of `maxTotal` for this configuration instance maxTotal) Sets the value for the `maxTotal` configuration attribute for pools created with this configuration instance.
public void	setMaxTotalPerKey(final int The new setting of `maxTotalPerKey` for this configuration instance maxTotalPerKey) Sets the value for the `maxTotalPerKey` configuration attribute for pools created with this configuration instance.
public void	setMinIdlePerKey(final int The new setting of `minIdlePerKey` for this configuration instance minIdlePerKey) Sets the value for the `minIdlePerKey` configuration attribute for pools created with this configuration instance.
public void	setReuseCapacityOnMaintenance(final boolean The new setting of `reuseCapacityOnMaintenance` for this configuration instance reuseCapacityOnMaintenance) Sets the value for the `reuseCapacityOnMaintenance` configuration attribute for pools created with this configuration instance.
public void	setReuseCapacityOnReturn(final boolean The new setting of `reuseCapacityOnReturn` for this configuration instance reuseCapacityOnReturn) Sets the value for the `reuseCapacityOnReturn` configuration attribute for pools created with this configuration instance.
protected void	toStringAppendFields(final StringBuilder builder) Overrides org.apache.commons.pool2.impl.BaseObjectPoolConfig.toStringAppendFields. Used by sub-classes to include the fields defined by the sub-class in the `toString()` output.

Inherited from org.apache.commons.pool2.impl.BaseObjectPoolConfig:: getBlockWhenExhausted getCollectDetailedStatistics getDurationBetweenEvictionRuns getEvictionPolicy getEvictionPolicyClassName getEvictorShutdownTimeout getEvictorShutdownTimeoutDuration getEvictorShutdownTimeoutMillis getFairness getJmxEnabled getJmxNameBase getJmxNamePrefix getLifo getMaxWaitDuration getMaxWaitMillis getMinEvictableIdleDuration getMinEvictableIdleTime getMinEvictableIdleTimeMillis getNumTestsPerEvictionRun getSoftMinEvictableIdleDuration getSoftMinEvictableIdleTime getSoftMinEvictableIdleTimeMillis getTestOnBorrow getTestOnCreate getTestOnReturn getTestWhileIdle getTimeBetweenEvictionRuns getTimeBetweenEvictionRunsMillis setBlockWhenExhausted setCollectDetailedStatistics setEvictionPolicy setEvictionPolicyClassName setEvictorShutdownTimeout setEvictorShutdownTimeoutMillis setEvictorShutdownTimeoutMillis setFairness setJmxEnabled setJmxNameBase setJmxNamePrefix setLifo setMaxWait setMaxWaitMillis setMinEvictableIdleDuration setMinEvictableIdleTime setMinEvictableIdleTimeMillis setNumTestsPerEvictionRun setSoftMinEvictableIdleDuration setSoftMinEvictableIdleTime setSoftMinEvictableIdleTimeMillis setTestOnBorrow setTestOnCreate setTestOnReturn setTestWhileIdle setTimeBetweenEvictionRuns setTimeBetweenEvictionRunsMillis

Field Detail

DEFAULT_MAX_IDLE_PER_KEY back to summary

DEFAULT_MAX_IDLE_PER_KEY	back to summary
public static final int DEFAULT_MAX_IDLE_PER_KEY The default value for the `maxIdlePerKey` configuration attribute: . See Also `GenericKeyedObjectPool#getMaxIdlePerKey()`

public static final int DEFAULT_MAX_IDLE_PER_KEY

The default value for the maxIdlePerKey configuration attribute: .

See Also: GenericKeyedObjectPool#getMaxIdlePerKey()

DEFAULT_MAX_TOTAL back to summary

DEFAULT_MAX_TOTAL	back to summary
public static final int DEFAULT_MAX_TOTAL The default value for the `maxTotal` configuration attribute: . See Also `GenericKeyedObjectPool#getMaxTotal()`

public static final int DEFAULT_MAX_TOTAL

The default value for the maxTotal configuration attribute: .

See Also: GenericKeyedObjectPool#getMaxTotal()

DEFAULT_MAX_TOTAL_PER_KEY back to summary

DEFAULT_MAX_TOTAL_PER_KEY	back to summary
public static final int DEFAULT_MAX_TOTAL_PER_KEY The default value for the `maxTotalPerKey` configuration attribute: . See Also `GenericKeyedObjectPool#getMaxTotalPerKey()`

public static final int DEFAULT_MAX_TOTAL_PER_KEY

The default value for the maxTotalPerKey configuration attribute: .

See Also: GenericKeyedObjectPool#getMaxTotalPerKey()

DEFAULT_MIN_IDLE_PER_KEY back to summary

DEFAULT_MIN_IDLE_PER_KEY	back to summary
public static final int DEFAULT_MIN_IDLE_PER_KEY The default value for the `minIdlePerKey` configuration attribute: . See Also `GenericKeyedObjectPool#getMinIdlePerKey()`

public static final int DEFAULT_MIN_IDLE_PER_KEY

The default value for the minIdlePerKey configuration attribute: .

See Also: GenericKeyedObjectPool#getMinIdlePerKey()

DEFAULT_REUSE_CAPACITY_ON_MAINTENANCE back to summary

DEFAULT_REUSE_CAPACITY_ON_MAINTENANCE	back to summary
public static final boolean DEFAULT_REUSE_CAPACITY_ON_MAINTENANCE The default value for the `reuseCapacityOnMaintenance` configuration attribute: . Since 2.13.0 See Also `GenericKeyedObjectPool#getReuseCapacityOnMaintenance()`

public static final boolean DEFAULT_REUSE_CAPACITY_ON_MAINTENANCE

The default value for the reuseCapacityOnMaintenance configuration attribute: .

Since: 2.13.0
See Also: GenericKeyedObjectPool#getReuseCapacityOnMaintenance()

DEFAULT_REUSE_CAPACITY_ON_RETURN back to summary

DEFAULT_REUSE_CAPACITY_ON_RETURN	back to summary
public static final boolean DEFAULT_REUSE_CAPACITY_ON_RETURN The default value for the `reuseCapacityOnReturn` configuration attribute: . Since 2.13.0 See Also `GenericKeyedObjectPool#getReuseCapacityOnReturn()`

public static final boolean DEFAULT_REUSE_CAPACITY_ON_RETURN

The default value for the reuseCapacityOnReturn configuration attribute: .

Since: 2.13.0
See Also: GenericKeyedObjectPool#getReuseCapacityOnReturn()

maxIdlePerKey	back to summary
private int maxIdlePerKey

maxTotal	back to summary
private int maxTotal

maxTotalPerKey	back to summary
private int maxTotalPerKey

minIdlePerKey	back to summary
private int minIdlePerKey

reuseCapacityOnMaintenance	back to summary
private boolean reuseCapacityOnMaintenance

reuseCapacityOnReturn	back to summary
private boolean reuseCapacityOnReturn

Constructor Detail

GenericKeyedObjectPoolConfig	back to summary
public GenericKeyedObjectPoolConfig() Constructs a new configuration with default settings.

Method Detail

clone back to summary

clone	back to summary
public GenericKeyedObjectPoolConfig<T> clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Annotations @SuppressWarnings:unchecked @Override

public GenericKeyedObjectPoolConfig<T> clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Annotations

@SuppressWarnings:unchecked
@Override

getMaxIdlePerKey back to summary

getMaxIdlePerKey	back to summary
public int getMaxIdlePerKey() Gets the value for the `maxIdlePerKey` configuration attribute for pools created with this configuration instance. Returns:int The current setting of `maxIdlePerKey` for this configuration instance See Also `GenericKeyedObjectPool#getMaxIdlePerKey()`

public int getMaxIdlePerKey()

Gets the value for the maxIdlePerKey configuration attribute for pools created with this configuration instance.

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

getMaxTotal back to summary

getMaxTotal	back to summary
public int getMaxTotal() Gets the value for the `maxTotal` configuration attribute for pools created with this configuration instance. Returns:int The current setting of `maxTotal` for this configuration instance See Also `GenericKeyedObjectPool#getMaxTotal()`

public int getMaxTotal()

Gets the value for the maxTotal configuration attribute for pools created with this configuration instance.

Returns:int: The current setting of maxTotal for this configuration instance
See Also: GenericKeyedObjectPool#getMaxTotal()

getMaxTotalPerKey back to summary

getMaxTotalPerKey	back to summary
public int getMaxTotalPerKey() Gets the value for the `maxTotalPerKey` configuration attribute for pools created with this configuration instance. Returns:int The current setting of `maxTotalPerKey` for this configuration instance See Also `GenericKeyedObjectPool#getMaxTotalPerKey()`

public int getMaxTotalPerKey()

Gets the value for the maxTotalPerKey configuration attribute for pools created with this configuration instance.

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

getMinIdlePerKey back to summary

getMinIdlePerKey	back to summary
public int getMinIdlePerKey() Gets the value for the `minIdlePerKey` configuration attribute for pools created with this configuration instance. Returns:int The current setting of `minIdlePerKey` for this configuration instance See Also `GenericKeyedObjectPool#getMinIdlePerKey()`

public int getMinIdlePerKey()

Gets the value for the minIdlePerKey configuration attribute for pools created with this configuration instance.

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

getReuseCapacityOnMaintenance back to summary

getReuseCapacityOnMaintenance	back to summary
public boolean getReuseCapacityOnMaintenance() Gets the value for the `reuseCapacityOnMaintenance` configuration attribute for pools created with this configuration instance. Returns:boolean The current setting of `reuseCapacityOnMaintenance` for this configuration instance Since 2.13.0 See Also `GenericKeyedObjectPool#getReuseCapacityOnMaintenance()`

public boolean getReuseCapacityOnMaintenance()

Gets the value for the reuseCapacityOnMaintenance configuration attribute for pools created with this configuration instance.

Returns:boolean: The current setting of reuseCapacityOnMaintenance for this configuration instance
Since: 2.13.0
See Also: GenericKeyedObjectPool#getReuseCapacityOnMaintenance()

getReuseCapacityOnReturn back to summary

getReuseCapacityOnReturn	back to summary
public boolean getReuseCapacityOnReturn() Gets the value for the `reuseCapacityOnReturn` configuration attribute for pools created with this configuration instance. Returns:boolean The current setting of `reuseCapacityOnReturn` for this configuration instance Since 2.13.0 See Also `GenericKeyedObjectPool#getReuseCapacityOnReturn()`

public boolean getReuseCapacityOnReturn()

Gets the value for the reuseCapacityOnReturn configuration attribute for pools created with this configuration instance.

Returns:boolean: The current setting of reuseCapacityOnReturn for this configuration instance
Since: 2.13.0
See Also: GenericKeyedObjectPool#getReuseCapacityOnReturn()

setMaxIdlePerKey back to summary

setMaxIdlePerKey	back to summary
public void setMaxIdlePerKey(final int maxIdlePerKey) Sets the value for the `maxIdlePerKey` configuration attribute for pools created with this configuration instance. Parameters maxIdlePerKey:int The new setting of `maxIdlePerKey` for this configuration instance See Also `GenericKeyedObjectPool#setMaxIdlePerKey(int)`

public void setMaxIdlePerKey(final int maxIdlePerKey)

Sets the value for the maxIdlePerKey configuration attribute for pools created with this configuration instance.

Parameters

maxIdlePerKey:int: The new setting of maxIdlePerKey for this configuration instance

setMaxTotal back to summary

setMaxTotal	back to summary
public void setMaxTotal(final int maxTotal) Sets the value for the `maxTotal` configuration attribute for pools created with this configuration instance. Parameters maxTotal:int The new setting of `maxTotal` for this configuration instance See Also `GenericKeyedObjectPool#setMaxTotal(int)`

public void setMaxTotal(final int maxTotal)

Sets the value for the maxTotal configuration attribute for pools created with this configuration instance.

Parameters

maxTotal:int: The new setting of maxTotal for this configuration instance

setMaxTotalPerKey back to summary

setMaxTotalPerKey	back to summary
public void setMaxTotalPerKey(final int maxTotalPerKey) Sets the value for the `maxTotalPerKey` configuration attribute for pools created with this configuration instance. Parameters maxTotalPerKey:int The new setting of `maxTotalPerKey` for this configuration instance See Also `GenericKeyedObjectPool#setMaxTotalPerKey(int)`

public void setMaxTotalPerKey(final int maxTotalPerKey)

Sets the value for the maxTotalPerKey configuration attribute for pools created with this configuration instance.

Parameters

maxTotalPerKey:int: The new setting of maxTotalPerKey for this configuration instance

setMinIdlePerKey back to summary

setMinIdlePerKey	back to summary
public void setMinIdlePerKey(final int minIdlePerKey) Sets the value for the `minIdlePerKey` configuration attribute for pools created with this configuration instance. Parameters minIdlePerKey:int The new setting of `minIdlePerKey` for this configuration instance See Also `GenericKeyedObjectPool#setMinIdlePerKey(int)`

public void setMinIdlePerKey(final int minIdlePerKey)

Sets the value for the minIdlePerKey configuration attribute for pools created with this configuration instance.

Parameters

minIdlePerKey:int: The new setting of minIdlePerKey for this configuration instance

setReuseCapacityOnMaintenance back to summary

setReuseCapacityOnMaintenance	back to summary
public void setReuseCapacityOnMaintenance(final boolean reuseCapacityOnMaintenance) Sets the value for the `reuseCapacityOnMaintenance` configuration attribute for pools created with this configuration instance. Parameters reuseCapacityOnMaintenance:boolean The new setting of `reuseCapacityOnMaintenance` for this configuration instance Since 2.13.0 See Also `GenericKeyedObjectPool#setReuseCapacityOnMaintenance(boolean)`

public void setReuseCapacityOnMaintenance(final boolean reuseCapacityOnMaintenance)

Sets the value for the reuseCapacityOnMaintenance configuration attribute for pools created with this configuration instance.

Parameters

reuseCapacityOnMaintenance:boolean: The new setting of reuseCapacityOnMaintenance for this configuration instance

Since

2.13.0

setReuseCapacityOnReturn back to summary

setReuseCapacityOnReturn	back to summary
public void setReuseCapacityOnReturn(final boolean reuseCapacityOnReturn) Sets the value for the `reuseCapacityOnReturn` configuration attribute for pools created with this configuration instance. Parameters reuseCapacityOnReturn:boolean The new setting of `reuseCapacityOnReturn` for this configuration instance Since 2.13.0 See Also `GenericKeyedObjectPool#setReuseCapacityOnReturn(boolean)`

public void setReuseCapacityOnReturn(final boolean reuseCapacityOnReturn)

Sets the value for the reuseCapacityOnReturn configuration attribute for pools created with this configuration instance.

Parameters

reuseCapacityOnReturn:boolean: The new setting of reuseCapacityOnReturn for this configuration instance

Since

2.13.0

toStringAppendFields back to summary

toStringAppendFields	back to summary
protected void toStringAppendFields(final StringBuilder builder) Overrides org.apache.commons.pool2.impl.BaseObjectPoolConfig.toStringAppendFields. Doc from org.apache.commons.pool2.BaseObject.toStringAppendFields. Used by sub-classes to include the fields defined by the sub-class in the `toString()` output. Annotations @Override

protected void toStringAppendFields(final StringBuilder builder)

Overrides org.apache.commons.pool2.impl.BaseObjectPoolConfig.toStringAppendFields.

Doc from org.apache.commons.pool2.BaseObject.toStringAppendFields.

Used by sub-classes to include the fields defined by the sub-class in the toString() output.

Annotations

@Override

public Class GenericKeyedObjectPoolConfig<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail