BaseGenericObjectPool

java.lang.Object
- org.apache.commons.pool2.BaseObject
- - org.apache.commons.pool2.impl.BaseGenericObjectPool<T>

类型参数:

T - Type of element pooled in this pool. This class is intended to be thread-safe.

直接已知子类:

GenericKeyedObjectPool, GenericObjectPool
```
public abstract class BaseGenericObjectPool<T>
extends BaseObject
```
Base class that provides common functionality for GenericObjectPool and GenericKeyedObjectPool. The primary reason this class exists is reduce code duplication between the two pool implementations.

从以下版本开始:

2.0

字段概要

字段
限定符和类型	字段和说明
`static int`	`MEAN_TIMING_STATS_CACHE_SIZE` The size of the caches used to store historical data for some attributes so that rolling means may be calculated.

构造器概要

构造器
构造器和说明
`BaseGenericObjectPool(BaseObjectPoolConfig<T> config, java.lang.String jmxNameBase, java.lang.String jmxNamePrefix)` Handles JMX registration (if required) and the initialization required for monitoring.

方法概要

所有方法实例方法抽象方法具体方法已过时的方法
限定符和类型	方法和说明
`abstract void`	`close()` Closes the pool, destroys the remaining idle objects and, if registered in JMX, deregisters it.
`abstract void`	`evict()` Perform `numTests` idle object eviction tests, evicting examined objects that meet the criteria for eviction.
`boolean`	`getBlockWhenExhausted()` Gets whether to block when the `borrowObject()` method is invoked when the pool is exhausted (the maximum number of "active" objects has been reached).
`long`	`getBorrowedCount()` The total number of objects successfully borrowed from this pool over the lifetime of the pool.
`long`	`getCreatedCount()` The total number of objects created for this pool over the lifetime of the pool.
`java.lang.String`	`getCreationStackTrace()` Provides the stack trace for the call that created this pool.
`long`	`getDestroyedByBorrowValidationCount()` The total number of objects destroyed by this pool as a result of failing validation during `borrowObject()` over the lifetime of the pool.
`long`	`getDestroyedByEvictorCount()` The total number of objects destroyed by the evictor associated with this pool over the lifetime of the pool.
`long`	`getDestroyedCount()` The total number of objects destroyed by this pool over the lifetime of the pool.
`EvictionPolicy<T>`	`getEvictionPolicy()` Gets the `EvictionPolicy` defined for this pool.
`java.lang.String`	`getEvictionPolicyClassName()` Gets the name of the `EvictionPolicy` implementation that is used by this pool.
`java.time.Duration`	`getEvictorShutdownTimeout()` Gets the timeout that will be used when waiting for the Evictor to shutdown if this pool is closed and it is the only pool still using the the value for the Evictor.
`long`	`getEvictorShutdownTimeoutMillis()` 已过时。 Use `getEvictorShutdownTimeout()`.
`boolean`	`getFairness()` Gets whether or not the pool serves threads waiting to borrow objects fairly.
`javax.management.ObjectName`	`getJmxName()` Provides the name under which the pool has been registered with the platform MBean server or `null` if the pool has not been registered.
`boolean`	`getLifo()` Gets whether the pool has LIFO (last in, first out) behavior with respect to idle objects - always returning the most recently used object from the pool, or as a FIFO (first in, first out) queue, where the pool always returns the oldest object in the idle object pool.
`long`	`getMaxBorrowWaitTimeMillis()` The maximum time a thread has waited to borrow objects from the pool.
`int`	`getMaxTotal()` Gets the maximum number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time.
`long`	`getMaxWaitMillis()` Gets the maximum amount of time (in milliseconds) the `borrowObject()` method should block before throwing an exception when the pool is exhausted and `getBlockWhenExhausted()` is true.
`long`	`getMeanActiveTimeMillis()` The mean time objects are active for based on the last `MEAN_TIMING_STATS_CACHE_SIZE` objects returned to the pool.
`long`	`getMeanBorrowWaitTimeMillis()` The mean time threads wait to borrow an object based on the last `MEAN_TIMING_STATS_CACHE_SIZE` objects borrowed from the pool.
`long`	`getMeanIdleTimeMillis()` The mean time objects are idle for based on the last `MEAN_TIMING_STATS_CACHE_SIZE` objects borrowed from the pool.
`java.time.Duration`	`getMinEvictableIdleTime()` Gets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see `setTimeBetweenEvictionRuns(Duration)`).
`long`	`getMinEvictableIdleTimeMillis()` 已过时。 Use `getMinEvictableIdleTime()`.
`abstract int`	`getNumIdle()` The number of instances currently idle in this pool.
`int`	`getNumTestsPerEvictionRun()` Gets the maximum number of objects to examine during each run (if any) of the idle object evictor thread.
`long`	`getReturnedCount()` The total number of objects returned to this pool over the lifetime of the pool.
`java.time.Duration`	`getSoftMinEvictableIdleTime()` Gets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see `setTimeBetweenEvictionRuns(Duration)`), with the extra condition that at least `minIdle` object instances remain in the pool.
`long`	`getSoftMinEvictableIdleTimeMillis()` 已过时。 Use `getSoftMinEvictableIdleTime()`.
`SwallowedExceptionListener`	`getSwallowedExceptionListener()` The listener used (if any) to receive notifications of exceptions unavoidably swallowed by the pool.
`boolean`	`getTestOnBorrow()` Gets whether objects borrowed from the pool will be validated before being returned from the `borrowObject()` method.
`boolean`	`getTestOnCreate()` Gets whether objects created for the pool will be validated before being returned from the `borrowObject()` method.
`boolean`	`getTestOnReturn()` Gets whether objects borrowed from the pool will be validated when they are returned to the pool via the `returnObject()` method.
`boolean`	`getTestWhileIdle()` Gets whether objects sitting idle in the pool will be validated by the idle object evictor (if any - see `setTimeBetweenEvictionRuns(Duration)`).
`java.time.Duration`	`getTimeBetweenEvictionRuns()` Gets the duration to sleep between runs of the idle object evictor thread.
`long`	`getTimeBetweenEvictionRunsMillis()` 已过时。 Use `getTimeBetweenEvictionRuns()`.
`boolean`	`isClosed()` Has this pool instance been closed.
`void`	`setBlockWhenExhausted(boolean blockWhenExhausted)` Sets whether to block when the `borrowObject()` method is invoked when the pool is exhausted (the maximum number of "active" objects has been reached).
`void`	`setEvictionPolicy(EvictionPolicy<T> evictionPolicy)` Sets the eviction policy for this pool.
`void`	`setEvictionPolicyClassName(java.lang.String evictionPolicyClassName)` Sets the name of the `EvictionPolicy` implementation that is used by this pool.
`void`	`setEvictionPolicyClassName(java.lang.String evictionPolicyClassName, java.lang.ClassLoader classLoader)` Sets the name of the `EvictionPolicy` implementation that is used by this pool.
`void`	`setEvictorShutdownTimeout(java.time.Duration evictorShutdownTimeoutMillis)` Sets the timeout that will be used when waiting for the Evictor to shutdown if this pool is closed and it is the only pool still using the the value for the Evictor.
`void`	`setEvictorShutdownTimeoutMillis(long evictorShutdownTimeoutMillis)` 已过时。 Use `setEvictorShutdownTimeout(Duration)`.
`void`	`setLifo(boolean lifo)` Sets whether the pool has LIFO (last in, first out) behavior with respect to idle objects - always returning the most recently used object from the pool, or as a FIFO (first in, first out) queue, where the pool always returns the oldest object in the idle object pool.
`void`	`setMaxTotal(int maxTotal)` Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time.
`void`	`setMaxWaitMillis(long maxWaitMillis)` Sets the maximum amount of time (in milliseconds) the `borrowObject()` method should block before throwing an exception when the pool is exhausted and `getBlockWhenExhausted()` is true.
`void`	`setMinEvictableIdleTime(java.time.Duration minEvictableIdleTimeMillis)` Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see `setTimeBetweenEvictionRuns(Duration)`).
`void`	`setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)` 已过时。 Use `setMinEvictableIdleTime(Duration)`.
`void`	`setNumTestsPerEvictionRun(int numTestsPerEvictionRun)` Sets the maximum number of objects to examine during each run (if any) of the idle object evictor thread.
`void`	`setSoftMinEvictableIdleTime(java.time.Duration softMinEvictableIdleTime)` Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see `setTimeBetweenEvictionRuns(Duration)`), with the extra condition that at least `minIdle` object instances remain in the pool.
`void`	`setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)` 已过时。 Use `setSoftMinEvictableIdleTime(Duration)`.
`void`	`setSwallowedExceptionListener(SwallowedExceptionListener swallowedExceptionListener)` The listener used (if any) to receive notifications of exceptions unavoidably swallowed by the pool.
`void`	`setTestOnBorrow(boolean testOnBorrow)` Sets whether objects borrowed from the pool will be validated before being returned from the `borrowObject()` method.
`void`	`setTestOnCreate(boolean testOnCreate)` Sets whether objects created for the pool will be validated before being returned from the `borrowObject()` method.
`void`	`setTestOnReturn(boolean testOnReturn)` Sets whether objects borrowed from the pool will be validated when they are returned to the pool via the `returnObject()` method.
`void`	`setTestWhileIdle(boolean testWhileIdle)` Sets whether objects sitting idle in the pool will be validated by the idle object evictor (if any - see `setTimeBetweenEvictionRuns(Duration)`).
`void`	`setTimeBetweenEvictionRuns(java.time.Duration timeBetweenEvictionRuns)` Sets the number of milliseconds to sleep between runs of the idle object evictor thread.
`void`	`setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)` 已过时。 Use `setTimeBetweenEvictionRuns(Duration)`.

从类继承的方法 org.apache.commons.pool2.BaseObject
toString

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - MEAN_TIMING_STATS_CACHE_SIZE
```
public static final int MEAN_TIMING_STATS_CACHE_SIZE
```
    The size of the caches used to store historical data for some attributes so that rolling means may be calculated.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - BaseGenericObjectPool
```
public BaseGenericObjectPool(BaseObjectPoolConfig<T> config,
                             java.lang.String jmxNameBase,
                             java.lang.String jmxNamePrefix)
```
    Handles JMX registration (if required) and the initialization required for monitoring.
    
    参数:
    
    config - Pool configuration
    
    jmxNameBase - The default base JMX name for the new pool unless overridden by the config
    
    jmxNamePrefix - Prefix to be used for JMX name for the new pool
- 方法详细资料
  - close
```
public abstract void close()
```
    Closes the pool, destroys the remaining idle objects and, if registered in JMX, deregisters it.
  - evict
```
public abstract void evict()
                    throws java.lang.Exception
```
    Perform numTests idle object eviction tests, evicting examined objects that meet the criteria for eviction. If testWhileIdle is true, examined objects are validated when visited (and removed if invalid); otherwise only objects that have been idle for more than minEvicableIdleTimeMillis are removed.
    
    抛出:
    
    java.lang.Exception - when there is a problem evicting idle objects.
  - getBlockWhenExhausted
```
public final boolean getBlockWhenExhausted()
```
    Gets whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of "active" objects has been reached).
    
    返回:
    
    true if borrowObject() should block when the pool is exhausted
    
    另请参阅:
    
    setBlockWhenExhausted(boolean)
  - getBorrowedCount
```
public final long getBorrowedCount()
```
    The total number of objects successfully borrowed from this pool over the lifetime of the pool.
    
    返回:
    
    the borrowed object count
  - getCreatedCount
```
public final long getCreatedCount()
```
    The total number of objects created for this pool over the lifetime of the pool.
    
    返回:
    
    the created object count
  - getCreationStackTrace
```
public final java.lang.String getCreationStackTrace()
```
    Provides the stack trace for the call that created this pool. JMX registration may trigger a memory leak so it is important that pools are deregistered when no longer used by calling the close() method. This method is provided to assist with identifying code that creates but does not close it thereby creating a memory leak.
    
    返回:
    
    pool creation stack trace
  - getDestroyedByBorrowValidationCount
```
public final long getDestroyedByBorrowValidationCount()
```
    The total number of objects destroyed by this pool as a result of failing validation during borrowObject() over the lifetime of the pool.
    
    返回:
    
    validation destroyed object count
  - getDestroyedByEvictorCount
```
public final long getDestroyedByEvictorCount()
```
    The total number of objects destroyed by the evictor associated with this pool over the lifetime of the pool.
    
    返回:
    
    the evictor destroyed object count
  - getDestroyedCount
```
public final long getDestroyedCount()
```
    The total number of objects destroyed by this pool over the lifetime of the pool.
    
    返回:
    
    the destroyed object count
  - getEvictionPolicy
```
public EvictionPolicy<T> getEvictionPolicy()
```
    Gets the EvictionPolicy defined for this pool.
    
    返回:
    
    the eviction policy
    
    从以下版本开始:
    
    2.4, 2.6.0 Changed access from protected to public.
  - getEvictionPolicyClassName
```
public final java.lang.String getEvictionPolicyClassName()
```
    Gets the name of the EvictionPolicy implementation that is used by this pool.
    
    返回:
    
    The fully qualified class name of the EvictionPolicy
    
    另请参阅:
    
    setEvictionPolicyClassName(String)
  - getEvictorShutdownTimeout
```
public final java.time.Duration getEvictorShutdownTimeout()
```
    Gets the timeout that will be used when waiting for the Evictor to shutdown if this pool is closed and it is the only pool still using the the value for the Evictor.
    
    返回:
    
    The timeout that will be used while waiting for the Evictor to shut down.
    
    从以下版本开始:
    
    2.10.0
  - getEvictorShutdownTimeoutMillis
```
@Deprecated
public final long getEvictorShutdownTimeoutMillis()
```
    已过时。 Use getEvictorShutdownTimeout().
    
    Gets the timeout that will be used when waiting for the Evictor to shutdown if this pool is closed and it is the only pool still using the the value for the Evictor.
    
    返回:
    
    The timeout in milliseconds that will be used while waiting for the Evictor to shut down.
  - getFairness
```
public final boolean getFairness()
```
    Gets whether or not the pool serves threads waiting to borrow objects fairly. True means that waiting threads are served as if waiting in a FIFO queue.
    
    返回:
    
    true if waiting threads are to be served by the pool in arrival order
  - getJmxName
```
public final javax.management.ObjectName getJmxName()
```
    Provides the name under which the pool has been registered with the platform MBean server or null if the pool has not been registered.
    
    返回:
    
    the JMX name
  - getLifo
```
public final boolean getLifo()
```
    Gets whether the pool has LIFO (last in, first out) behavior with respect to idle objects - always returning the most recently used object from the pool, or as a FIFO (first in, first out) queue, where the pool always returns the oldest object in the idle object pool.
    
    返回:
    
    true if the pool is configured with LIFO behavior or false if the pool is configured with FIFO behavior
    
    另请参阅:
    
    setLifo(boolean)
  - getMaxBorrowWaitTimeMillis
```
public final long getMaxBorrowWaitTimeMillis()
```
    The maximum time a thread has waited to borrow objects from the pool.
    
    返回:
    
    maximum wait time in milliseconds since the pool was created
  - getMaxTotal
```
public final int getMaxTotal()
```
    Gets the maximum number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. When negative, there is no limit to the number of objects that can be managed by the pool at one time.
    
    返回:
    
    the cap on the total number of object instances managed by the pool.
    
    另请参阅:
    
    setMaxTotal(int)
  - getMaxWaitMillis
```
public final long getMaxWaitMillis()
```
    Gets the maximum amount of time (in milliseconds) the borrowObject() method should block before throwing an exception when the pool is exhausted and getBlockWhenExhausted() is true. When less than 0, the borrowObject() method may block indefinitely.
    
    返回:
    
    the maximum number of milliseconds borrowObject() will block.
    
    另请参阅:
    
    setMaxWaitMillis(long), setBlockWhenExhausted(boolean)
  - getMeanActiveTimeMillis
```
public final long getMeanActiveTimeMillis()
```
    The mean time objects are active for based on the last MEAN_TIMING_STATS_CACHE_SIZE objects returned to the pool.
    
    返回:
    
    mean time an object has been checked out from the pool among recently returned objects
  - getMeanBorrowWaitTimeMillis
```
public final long getMeanBorrowWaitTimeMillis()
```
    The mean time threads wait to borrow an object based on the last MEAN_TIMING_STATS_CACHE_SIZE objects borrowed from the pool.
    
    返回:
    
    mean time in milliseconds that a recently served thread has had to wait to borrow an object from the pool
  - getMeanIdleTimeMillis
```
public final long getMeanIdleTimeMillis()
```
    The mean time objects are idle for based on the last MEAN_TIMING_STATS_CACHE_SIZE objects borrowed from the pool.
    
    返回:
    
    mean time an object has been idle in the pool among recently borrowed objects
  - getMinEvictableIdleTime
```
public final java.time.Duration getMinEvictableIdleTime()
```
    Gets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRuns(Duration)). When non-positive, no objects will be evicted from the pool due to idle time alone.
    
    返回:
    
    minimum amount of time an object may sit idle in the pool before it is eligible for eviction
    
    从以下版本开始:
    
    2.10.0
    
    另请参阅:
    
    setMinEvictableIdleTimeMillis(long), setTimeBetweenEvictionRunsMillis(long)
  - getMinEvictableIdleTimeMillis
```
@Deprecated
public final long getMinEvictableIdleTimeMillis()
```
    已过时。 Use getMinEvictableIdleTime().
    
    Gets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)). When non-positive, no objects will be evicted from the pool due to idle time alone.
    
    返回:
    
    minimum amount of time an object may sit idle in the pool before it is eligible for eviction
    
    另请参阅:
    
    setMinEvictableIdleTimeMillis(long), setTimeBetweenEvictionRunsMillis(long)
  - getNumIdle
```
public abstract int getNumIdle()
```
    The number of instances currently idle in this pool.
    
    返回:
    
    count of instances available for checkout from the pool
  - getNumTestsPerEvictionRun
```
public final int getNumTestsPerEvictionRun()
```
    Gets the maximum number of objects to examine during each run (if any) of the idle object evictor thread. When positive, the number of tests performed for a run will be the minimum of the configured value and the number of idle instances in the pool. When negative, the number of tests performed will be ceil(getNumIdle()/ abs(getNumTestsPerEvictionRun())) which means that when the value is -n roughly one nth of the idle objects will be tested per run.
    
    返回:
    
    max number of objects to examine during each evictor run
    
    另请参阅:
    
    setNumTestsPerEvictionRun(int), setTimeBetweenEvictionRunsMillis(long)
  - getReturnedCount
```
public final long getReturnedCount()
```
    The total number of objects returned to this pool over the lifetime of the pool. This excludes attempts to return the same object multiple times.
    
    返回:
    
    the returned object count
  - getSoftMinEvictableIdleTime
```
public final java.time.Duration getSoftMinEvictableIdleTime()
```
    Gets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRuns(Duration)), with the extra condition that at least minIdle object instances remain in the pool. This setting is overridden by getMinEvictableIdleTime() (that is, if getMinEvictableIdleTime() is positive, then getSoftMinEvictableIdleTime() is ignored).
    
    返回:
    
    minimum amount of time an object may sit idle in the pool before it is eligible for eviction if minIdle instances are available
    
    从以下版本开始:
    
    2.10.0
    
    另请参阅:
    
    setSoftMinEvictableIdleTime(Duration)
  - getSoftMinEvictableIdleTimeMillis
```
@Deprecated
public final long getSoftMinEvictableIdleTimeMillis()
```
    已过时。 Use getSoftMinEvictableIdleTime().
    
    Gets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)), with the extra condition that at least minIdle object instances remain in the pool. This setting is overridden by getMinEvictableIdleTimeMillis() (that is, if getMinEvictableIdleTimeMillis() is positive, then getSoftMinEvictableIdleTimeMillis() is ignored).
    
    返回:
    
    minimum amount of time an object may sit idle in the pool before it is eligible for eviction if minIdle instances are available
    
    另请参阅:
    
    setSoftMinEvictableIdleTimeMillis(long)
  - getSwallowedExceptionListener
```
public final SwallowedExceptionListener getSwallowedExceptionListener()
```
    The listener used (if any) to receive notifications of exceptions unavoidably swallowed by the pool.
    
    返回:
    
    The listener or null for no listener
  - getTestOnBorrow
```
public final boolean getTestOnBorrow()
```
    Gets whether objects borrowed from the pool will be validated before being returned from the borrowObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, it will be removed from the pool and destroyed, and a new attempt will be made to borrow an object from the pool.
    
    返回:
    
    true if objects are validated before being returned from the borrowObject() method
    
    另请参阅:
    
    setTestOnBorrow(boolean)
  - getTestOnCreate
```
public final boolean getTestOnCreate()
```
    Gets whether objects created for the pool will be validated before being returned from the borrowObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, then borrowObject() will fail.
    
    返回:
    
    true if newly created objects are validated before being returned from the borrowObject() method
    
    从以下版本开始:
    
    2.2
    
    另请参阅:
    
    setTestOnCreate(boolean)
  - getTestOnReturn
```
public final boolean getTestOnReturn()
```
    Gets whether objects borrowed from the pool will be validated when they are returned to the pool via the returnObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. Returning objects that fail validation are destroyed rather then being returned the pool.
    
    返回:
    
    true if objects are validated on return to the pool via the returnObject() method
    
    另请参阅:
    
    setTestOnReturn(boolean)
  - getTestWhileIdle
```
public final boolean getTestWhileIdle()
```
    Gets whether objects sitting idle in the pool will be validated by the idle object evictor (if any - see setTimeBetweenEvictionRuns(Duration)). Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, it will be removed from the pool and destroyed.
    
    返回:
    
    true if objects will be validated by the evictor
    
    另请参阅:
    
    setTestWhileIdle(boolean), setTimeBetweenEvictionRunsMillis(long)
  - getTimeBetweenEvictionRuns
```
public final java.time.Duration getTimeBetweenEvictionRuns()
```
    Gets the duration to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run.
    
    返回:
    
    number of milliseconds to sleep between evictor runs
    
    从以下版本开始:
    
    2.10.0
    
    另请参阅:
    
    setTimeBetweenEvictionRuns(java.time.Duration)
  - getTimeBetweenEvictionRunsMillis
```
@Deprecated
public final long getTimeBetweenEvictionRunsMillis()
```
    已过时。 Use getTimeBetweenEvictionRuns().
    
    Gets the number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run.
    
    返回:
    
    number of milliseconds to sleep between evictor runs
    
    另请参阅:
    
    setTimeBetweenEvictionRunsMillis(long)
  - isClosed
```
public final boolean isClosed()
```
    Has this pool instance been closed.
    
    返回:
    
    true when this pool has been closed.
  - setBlockWhenExhausted
```
public final void setBlockWhenExhausted(boolean blockWhenExhausted)
```
    Sets whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of "active" objects has been reached).
    
    参数:
    
    blockWhenExhausted - true if borrowObject() should block when the pool is exhausted
    
    另请参阅:
    
    getBlockWhenExhausted()
  - setEvictionPolicy
```
public void setEvictionPolicy(EvictionPolicy<T> evictionPolicy)
```
    Sets the eviction policy for this pool.
    
    参数:
    
    evictionPolicy - the eviction policy for this pool.
    
    从以下版本开始:
    
    2.6.0
  - setEvictionPolicyClassName
```
public final void setEvictionPolicyClassName(java.lang.String evictionPolicyClassName)
```
    Sets the name of the EvictionPolicy implementation that is used by this pool. The Pool will attempt to load the class using the thread context class loader. If that fails, the use the class loader for the EvictionPolicy interface.
    
    参数:
    
    evictionPolicyClassName - the fully qualified class name of the new eviction policy
    
    从以下版本开始:
    
    2.6.0 If loading the class using the thread context class loader fails, use the class loader for the EvictionPolicy interface.
    
    另请参阅:
    
    getEvictionPolicyClassName()
  - setEvictionPolicyClassName
```
public final void setEvictionPolicyClassName(java.lang.String evictionPolicyClassName,
                                             java.lang.ClassLoader classLoader)
```
    Sets the name of the EvictionPolicy implementation that is used by this pool. The Pool will attempt to load the class using the given class loader. If that fails, use the class loader for the EvictionPolicy interface.
    
    参数:
    
    evictionPolicyClassName - the fully qualified class name of the new eviction policy
    
    classLoader - the class loader to load the given evictionPolicyClassName.
    
    从以下版本开始:
    
    2.6.0 If loading the class using the given class loader fails, use the class loader for the EvictionPolicy interface.
    
    另请参阅:
    
    getEvictionPolicyClassName()
  - setEvictorShutdownTimeout
```
public final void setEvictorShutdownTimeout(java.time.Duration evictorShutdownTimeoutMillis)
```
    Sets the timeout that will be used when waiting for the Evictor to shutdown if this pool is closed and it is the only pool still using the the value for the Evictor.
    
    参数:
    
    evictorShutdownTimeoutMillis - the timeout in milliseconds that will be used while waiting for the Evictor to shut down.
    
    从以下版本开始:
    
    2.10.0
  - setEvictorShutdownTimeoutMillis
```
@Deprecated
public final void setEvictorShutdownTimeoutMillis(long evictorShutdownTimeoutMillis)
```
    已过时。 Use setEvictorShutdownTimeout(Duration).
    
    Sets the timeout that will be used when waiting for the Evictor to shutdown if this pool is closed and it is the only pool still using the the value for the Evictor.
    
    参数:
    
    evictorShutdownTimeoutMillis - the timeout in milliseconds that will be used while waiting for the Evictor to shut down.
  - setLifo
```
public final void setLifo(boolean lifo)
```
    Sets whether the pool has LIFO (last in, first out) behavior with respect to idle objects - always returning the most recently used object from the pool, or as a FIFO (first in, first out) queue, where the pool always returns the oldest object in the idle object pool.
    
    参数:
    
    lifo - true if the pool is to be configured with LIFO behavior or false if the pool is to be configured with FIFO behavior
    
    另请参阅:
    
    getLifo()
  - setMaxTotal
```
public final void setMaxTotal(int maxTotal)
```
    Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit.
    
    参数:
    
    maxTotal - The cap on the total number of object instances managed by the pool. Negative values mean that there is no limit to the number of objects allocated by the pool.
    
    另请参阅:
    
    getMaxTotal()
  - setMaxWaitMillis
```
public final void setMaxWaitMillis(long maxWaitMillis)
```
    Sets the maximum amount of time (in milliseconds) the borrowObject() method should block before throwing an exception when the pool is exhausted and getBlockWhenExhausted() is true. When less than 0, the borrowObject() method may block indefinitely.
    
    参数:
    
    maxWaitMillis - the maximum number of milliseconds borrowObject() will block or negative for indefinitely.
    
    另请参阅:
    
    getMaxWaitMillis(), setBlockWhenExhausted(boolean)
  - setMinEvictableIdleTime
```
public final void setMinEvictableIdleTime(java.time.Duration minEvictableIdleTimeMillis)
```
    Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRuns(Duration)). When non-positive, no objects will be evicted from the pool due to idle time alone.
    
    参数:
    
    minEvictableIdleTimeMillis - minimum amount of time an object may sit idle in the pool before it is eligible for eviction
    
    从以下版本开始:
    
    2.10.0
    
    另请参阅:
    
    getMinEvictableIdleTime(), setTimeBetweenEvictionRuns(java.time.Duration)
  - setMinEvictableIdleTimeMillis
```
@Deprecated
public final void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
```
    已过时。 Use setMinEvictableIdleTime(Duration).
    
    Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)). When non-positive, no objects will be evicted from the pool due to idle time alone.
    
    参数:
    
    minEvictableIdleTimeMillis - minimum amount of time an object may sit idle in the pool before it is eligible for eviction
    
    另请参阅:
    
    getMinEvictableIdleTimeMillis(), setTimeBetweenEvictionRunsMillis(long)
  - setNumTestsPerEvictionRun
```
public final void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
```
    Sets the maximum number of objects to examine during each run (if any) of the idle object evictor thread. When positive, the number of tests performed for a run will be the minimum of the configured value and the number of idle instances in the pool. When negative, the number of tests performed will be ceil(getNumIdle()/ abs(getNumTestsPerEvictionRun())) which means that when the value is -n roughly one nth of the idle objects will be tested per run.
    
    参数:
    
    numTestsPerEvictionRun - max number of objects to examine during each evictor run
    
    另请参阅:
    
    getNumTestsPerEvictionRun(), setTimeBetweenEvictionRunsMillis(long)
  - setSoftMinEvictableIdleTime
```
public final void setSoftMinEvictableIdleTime(java.time.Duration softMinEvictableIdleTime)
```
    Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRuns(Duration)), with the extra condition that at least minIdle object instances remain in the pool. This setting is overridden by getMinEvictableIdleTime() (that is, if getMinEvictableIdleTime() is positive, then getSoftMinEvictableIdleTime() is ignored).
    
    参数:
    
    softMinEvictableIdleTime - minimum amount of time an object may sit idle in the pool before it is eligible for eviction if minIdle instances are available
    
    从以下版本开始:
    
    2.10.0
    
    另请参阅:
    
    getSoftMinEvictableIdleTimeMillis()
  - setSoftMinEvictableIdleTimeMillis
```
@Deprecated
public final void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
```
    已过时。 Use setSoftMinEvictableIdleTime(Duration).
    
    Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)), with the extra condition that at least minIdle object instances remain in the pool. This setting is overridden by getMinEvictableIdleTimeMillis() (that is, if getMinEvictableIdleTimeMillis() is positive, then getSoftMinEvictableIdleTimeMillis() is ignored).
    
    参数:
    
    softMinEvictableIdleTimeMillis - minimum amount of time an object may sit idle in the pool before it is eligible for eviction if minIdle instances are available
    
    另请参阅:
    
    getSoftMinEvictableIdleTimeMillis()
  - setSwallowedExceptionListener
```
public final void setSwallowedExceptionListener(SwallowedExceptionListener swallowedExceptionListener)
```
    The listener used (if any) to receive notifications of exceptions unavoidably swallowed by the pool.
    
    参数:
    
    swallowedExceptionListener - The listener or null for no listener
  - setTestOnBorrow
```
public final void setTestOnBorrow(boolean testOnBorrow)
```
    Sets whether objects borrowed from the pool will be validated before being returned from the borrowObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, it will be removed from the pool and destroyed, and a new attempt will be made to borrow an object from the pool.
    
    参数:
    
    testOnBorrow - true if objects should be validated before being returned from the borrowObject() method
    
    另请参阅:
    
    getTestOnBorrow()
  - setTestOnCreate
```
public final void setTestOnCreate(boolean testOnCreate)
```
    Sets whether objects created for the pool will be validated before being returned from the borrowObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, then borrowObject() will fail.
    
    参数:
    
    testOnCreate - true if newly created objects should be validated before being returned from the borrowObject() method
    
    从以下版本开始:
    
    2.2
    
    另请参阅:
    
    getTestOnCreate()
  - setTestOnReturn
```
public final void setTestOnReturn(boolean testOnReturn)
```
    Sets whether objects borrowed from the pool will be validated when they are returned to the pool via the returnObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. Returning objects that fail validation are destroyed rather then being returned the pool.
    
    参数:
    
    testOnReturn - true if objects are validated on return to the pool via the returnObject() method
    
    另请参阅:
    
    getTestOnReturn()
  - setTestWhileIdle
```
public final void setTestWhileIdle(boolean testWhileIdle)
```
    Sets whether objects sitting idle in the pool will be validated by the idle object evictor (if any - see setTimeBetweenEvictionRuns(Duration)). Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, it will be removed from the pool and destroyed. Note that setting this property has no effect unless the idle object evictor is enabled by setting timeBetweenEvictionRunsMillis to a positive value.
    
    参数:
    
    testWhileIdle - true so objects will be validated by the evictor
    
    另请参阅:
    
    getTestWhileIdle(), setTimeBetweenEvictionRuns(java.time.Duration)
  - setTimeBetweenEvictionRuns
```
public final void setTimeBetweenEvictionRuns(java.time.Duration timeBetweenEvictionRuns)
```
    Sets the number of milliseconds to sleep between runs of the idle object evictor thread.
    - When positive, the idle object evictor thread starts.
    - When non-positive, no idle object evictor thread runs.
    参数:
    
    timeBetweenEvictionRuns - duration to sleep between evictor runs
    
    从以下版本开始:
    
    2.10.0
    
    另请参阅:
    
    getTimeBetweenEvictionRunsMillis()
  - setTimeBetweenEvictionRunsMillis
```
@Deprecated
public final void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
```
    已过时。 Use setTimeBetweenEvictionRuns(Duration).
    Sets the number of milliseconds to sleep between runs of the idle object evictor thread.
    - When positive, the idle object evictor thread starts.
    - When non-positive, no idle object evictor thread runs.
    参数:
    
    timeBetweenEvictionRunsMillis - number of milliseconds to sleep between evictor runs
    
    另请参阅:
    
    getTimeBetweenEvictionRunsMillis()

类 BaseGenericObjectPool<T>

字段概要

构造器概要

方法概要

从类继承的方法 org.apache.commons.pool2.BaseObject

从类继承的方法 java.lang.Object

字段详细资料

MEAN_TIMING_STATS_CACHE_SIZE

构造器详细资料

BaseGenericObjectPool

方法详细资料

close

evict

getBlockWhenExhausted

getBorrowedCount

getCreatedCount

getCreationStackTrace

getDestroyedByBorrowValidationCount

getDestroyedByEvictorCount

getDestroyedCount

getEvictionPolicy

getEvictionPolicyClassName

getEvictorShutdownTimeout

getEvictorShutdownTimeoutMillis

getFairness

getJmxName

getLifo

getMaxBorrowWaitTimeMillis

getMaxTotal

getMaxWaitMillis

getMeanActiveTimeMillis

getMeanBorrowWaitTimeMillis

getMeanIdleTimeMillis

getMinEvictableIdleTime

getMinEvictableIdleTimeMillis

getNumIdle

getNumTestsPerEvictionRun

getReturnedCount

getSoftMinEvictableIdleTime

getSoftMinEvictableIdleTimeMillis

getSwallowedExceptionListener

getTestOnBorrow

getTestOnCreate

getTestOnReturn

getTestWhileIdle

getTimeBetweenEvictionRuns

getTimeBetweenEvictionRunsMillis

isClosed

setBlockWhenExhausted

setEvictionPolicy

setEvictionPolicyClassName

setEvictionPolicyClassName

setEvictorShutdownTimeout

setEvictorShutdownTimeoutMillis

setLifo

setMaxTotal

setMaxWaitMillis

setMinEvictableIdleTime

setMinEvictableIdleTimeMillis

setNumTestsPerEvictionRun

setSoftMinEvictableIdleTime

setSoftMinEvictableIdleTimeMillis

setSwallowedExceptionListener

setTestOnBorrow

setTestOnCreate

setTestOnReturn

setTestWhileIdle

setTimeBetweenEvictionRuns

setTimeBetweenEvictionRunsMillis