GenericObjectPool

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

类型参数:

T - Type of element pooled in this pool.

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, GenericObjectPoolMXBean, ObjectPool<T>, UsageTracking<T>
```
public class GenericObjectPool<T>
extends BaseGenericObjectPool<T>
implements ObjectPool<T>, GenericObjectPoolMXBean, UsageTracking<T>
```
A configurable ObjectPool implementation.
When coupled with the appropriate PooledObjectFactory, GenericObjectPool provides robust pooling functionality for arbitrary objects.

Optionally, one may configure the pool to examine and possibly evict objects as they sit idle in the pool and to ensure that a minimum number of idle objects are available. This is performed by an "idle object eviction" thread, which runs asynchronously. Caution should be used when configuring this optional feature. Eviction runs contend with client threads for access to objects in the pool, so if they run too frequently performance issues may result.

The pool can also be configured to detect and remove "abandoned" objects, i.e. objects that have been checked out of the pool but neither used nor returned before the configured removeAbandonedTimeout. Abandoned object removal can be configured to happen when borrowObject is invoked and the pool is close to starvation, or it can be executed by the idle object evictor, or both. If pooled objects implement the TrackedUse interface, their last use will be queried using the getLastUsed method on that interface; otherwise abandonment is determined by how long an object has been checked out from the pool.

Implementation note: To prevent possible deadlocks, care has been taken to ensure that no call to a factory method will occur within a synchronization block. See POOL-125 and DBCP-44 for more information.

This class is intended to be thread-safe.

从以下版本开始:

2.0

另请参阅:

GenericKeyedObjectPool

字段概要
- 从类继承的字段 org.apache.commons.pool2.impl.BaseGenericObjectPool
  MEAN_TIMING_STATS_CACHE_SIZE

构造器概要

构造器
构造器和说明
`GenericObjectPool(PooledObjectFactory<T> factory)` Creates a new `GenericObjectPool` using defaults from `GenericObjectPoolConfig`.
`GenericObjectPool(PooledObjectFactory<T> factory, GenericObjectPoolConfig<T> config)` Creates a new `GenericObjectPool` using a specific configuration.
`GenericObjectPool(PooledObjectFactory<T> factory, GenericObjectPoolConfig<T> config, AbandonedConfig abandonedConfig)` Creates a new `GenericObjectPool` that tracks and destroys objects that are checked out, but never returned to the pool.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addObject()` Creates an object, and place it into the pool. addObject() is useful for "pre-loading" a pool with idle objects.
`T`	`borrowObject()` Equivalent to `borrowObject(BaseGenericObjectPool.getMaxWaitMillis())`.
`T`	`borrowObject(java.time.Duration borrowMaxWait)` Borrows an object from the pool using the specific waiting time which only applies if `BaseGenericObjectPool.getBlockWhenExhausted()` is true.
`T`	`borrowObject(long borrowMaxWaitMillis)` Borrows an object from the pool using the specific waiting time which only applies if `BaseGenericObjectPool.getBlockWhenExhausted()` is true.
`void`	`clear()` Clears any objects sitting idle in the pool by removing them from the idle instance pool and then invoking the configured `PooledObjectFactory.destroyObject(PooledObject)` method on each idle instance.
`void`	`close()` Closes the pool.
`void`	`evict()` Perform `numTests` idle object eviction tests, evicting examined objects that meet the criteria for eviction.
`PooledObjectFactory<T>`	`getFactory()` Gets a reference to the factory used to create, destroy and validate the objects used by this pool.
`java.lang.String`	`getFactoryType()` Gets the type - including the specific type rather than the generic - of the factory.
`boolean`	`getLogAbandoned()` Gets whether this pool identifies and logs any abandoned objects.
`int`	`getMaxIdle()` Gets the cap on the number of "idle" instances in the pool.
`int`	`getMinIdle()` Gets the target for the minimum number of idle objects to maintain in the pool.
`int`	`getNumActive()` Gets the number of instances currently borrowed from this pool.
`int`	`getNumIdle()` The number of instances currently idle in this pool.
`int`	`getNumWaiters()` Gets an estimate of the number of threads currently blocked waiting for an object from the pool.
`boolean`	`getRemoveAbandonedOnBorrow()` Gets whether a check is made for abandoned objects when an object is borrowed from this pool.
`boolean`	`getRemoveAbandonedOnMaintenance()` Gets whether a check is made for abandoned objects when the evictor runs.
`int`	`getRemoveAbandonedTimeout()` 已过时。 Use `getRemoveAbandonedTimeoutDuration()`.
`java.time.Duration`	`getRemoveAbandonedTimeoutDuration()` Gets the timeout before which an object will be considered to be abandoned by this pool.
`void`	`invalidateObject(T obj)` Invalidates an object from the pool.
`void`	`invalidateObject(T obj, DestroyMode mode)` Invalidates an object from the pool, using the provided `DestroyMode` By contract, `obj` must have been obtained using `ObjectPool.borrowObject()` or a related method as defined in an implementation or sub-interface.
`boolean`	`isAbandonedConfig()` Gets whether or not abandoned object removal is configured for this pool.
`java.util.Set<DefaultPooledObjectInfo>`	`listAllObjects()` Provides information on all the objects in the pool, both idle (waiting to be borrowed) and active (currently borrowed).
`void`	`preparePool()` Tries to ensure that `getMinIdle()` idle instances are available in the pool.
`void`	`returnObject(T obj)` Returns an instance to the pool.
`void`	`setAbandonedConfig(AbandonedConfig abandonedConfig)` Sets the abandoned object removal configuration.
`void`	`setConfig(GenericObjectPoolConfig<T> conf)` Sets the base pool configuration.
`void`	`setMaxIdle(int maxIdle)` Sets the cap on the number of "idle" instances in the pool.
`void`	`setMinIdle(int minIdle)` Sets the target for the minimum number of idle objects to maintain in the pool.
`void`	`use(T pooledObject)` This method is called every time a pooled object is used to enable the pool to better track borrowed objects.

从类继承的方法 org.apache.commons.pool2.impl.BaseGenericObjectPool
getBlockWhenExhausted, getBorrowedCount, getCreatedCount, getCreationStackTrace, getDestroyedByBorrowValidationCount, getDestroyedByEvictorCount, getDestroyedCount, getEvictionPolicy, getEvictionPolicyClassName, getEvictorShutdownTimeout, getEvictorShutdownTimeoutMillis, getFairness, getJmxName, getLifo, getMaxBorrowWaitTimeMillis, getMaxTotal, getMaxWaitMillis, getMeanActiveTimeMillis, getMeanBorrowWaitTimeMillis, getMeanIdleTimeMillis, getMinEvictableIdleTime, getMinEvictableIdleTimeMillis, 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

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

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

从接口继承的方法 org.apache.commons.pool2.ObjectPool
addObjects

- 构造器详细资料
  - GenericObjectPool
```
public GenericObjectPool(PooledObjectFactory<T> factory)
```
    Creates a new GenericObjectPool using defaults from GenericObjectPoolConfig.
    
    参数:
    
    factory - The object factory to be used to create object instances used by this pool
  - GenericObjectPool
```
public GenericObjectPool(PooledObjectFactory<T> factory,
                         GenericObjectPoolConfig<T> config)
```
    Creates a new GenericObjectPool using a specific configuration.
    
    参数:
    
    factory - The object factory to be used to create object instances used by this pool
    
    config - The configuration to use for this pool instance. The configuration is used by value. Subsequent changes to the configuration object will not be reflected in the pool.
  - GenericObjectPool
```
public GenericObjectPool(PooledObjectFactory<T> factory,
                         GenericObjectPoolConfig<T> config,
                         AbandonedConfig abandonedConfig)
```
    Creates a new GenericObjectPool that tracks and destroys objects that are checked out, but never returned to the pool.
    
    参数:
    
    factory - The object factory to be used to create object instances used by this pool
    
    config - The base pool configuration to use for this pool instance. The configuration is used by value. Subsequent changes to the configuration object will not be reflected in the pool.
    
    abandonedConfig - Configuration for abandoned object identification and removal. The configuration is used by value.
- 方法详细资料
  - addObject
```
public void addObject()
               throws java.lang.Exception
```
    Creates an object, and place it into the pool. addObject() is useful for "pre-loading" a pool with idle objects.
    If there is no capacity available to add to the pool, this is a no-op (no exception, no impact to the pool).
    
    指定者:
    
    addObject 在接口中 ObjectPool<T>
    
    抛出:
    
    java.lang.Exception - when PooledObjectFactory.makeObject() fails.
    
    java.lang.IllegalStateException - after ObjectPool.close() has been called on this pool.
    
    java.lang.UnsupportedOperationException - when this pool cannot add new idle objects.
  - borrowObject
```
public T borrowObject()
               throws java.lang.Exception
```
    Equivalent to borrowObject(BaseGenericObjectPool.getMaxWaitMillis()).
    Borrows an instance from this pool.
    Instances returned from this method will have been either newly created with PooledObjectFactory.makeObject() or will be a previously idle object and have been activated with PooledObjectFactory.activateObject(org.apache.commons.pool2.PooledObject<T>) and then validated with PooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject<T>).
    
    By contract, clients must return the borrowed instance using ObjectPool.returnObject(T), ObjectPool.invalidateObject(T), or a related method as defined in an implementation or sub-interface.
    
    The behavior of this method when the pool has been exhausted is not strictly specified (although it may be specified by implementations).
    
    指定者:
    
    borrowObject 在接口中 ObjectPool<T>
    
    返回:
    
    an instance from this pool.
    
    抛出:
    
    java.lang.IllegalStateException - after close has been called on this pool.
    
    java.lang.Exception - when PooledObjectFactory.makeObject() throws an exception.
    
    java.util.NoSuchElementException - when the pool is exhausted and cannot or will not return another instance.
  - borrowObject
```
public T borrowObject(java.time.Duration borrowMaxWait)
               throws java.lang.Exception
```
    Borrows an object from the pool using the specific waiting time which only applies if BaseGenericObjectPool.getBlockWhenExhausted() is true.
    If there is one or more idle instance available in the pool, then an idle instance will be selected based on the value of BaseGenericObjectPool.getLifo(), activated and returned. If activation fails, or testOnBorrow is set to true and validation fails, the instance is destroyed and the next available instance is examined. This continues until either a valid instance is returned or there are no more idle instances available.
    
    If there are no idle instances available in the pool, behavior depends on the maxTotal, (if applicable) BaseGenericObjectPool.getBlockWhenExhausted() and the value passed in to the borrowMaxWaitMillis parameter. If the number of instances checked out from the pool is less than maxTotal, a new instance is created, activated and (if applicable) validated and returned to the caller. If validation fails, a NoSuchElementException is thrown.
    
    If the pool is exhausted (no available idle instances and no capacity to create new ones), this method will either block (if BaseGenericObjectPool.getBlockWhenExhausted() is true) or throw a NoSuchElementException (if BaseGenericObjectPool.getBlockWhenExhausted() is false). The length of time that this method will block when BaseGenericObjectPool.getBlockWhenExhausted() is true is determined by the value passed in to the borrowMaxWaitMillis parameter.
    
    When the pool is exhausted, multiple calling threads may be simultaneously blocked waiting for instances to become available. A "fairness" algorithm has been implemented to ensure that threads receive available instances in request arrival order.
    
    参数:
    
    borrowMaxWait - The time to wait for an object to become available
    
    返回:
    
    object instance from the pool
    
    抛出:
    
    java.util.NoSuchElementException - if an instance cannot be returned
    
    java.lang.Exception - if an object instance cannot be returned due to an error
    
    从以下版本开始:
    
    2.10.0
  - borrowObject
```
public T borrowObject(long borrowMaxWaitMillis)
               throws java.lang.Exception
```
    Borrows an object from the pool using the specific waiting time which only applies if BaseGenericObjectPool.getBlockWhenExhausted() is true.
    If there is one or more idle instance available in the pool, then an idle instance will be selected based on the value of BaseGenericObjectPool.getLifo(), activated and returned. If activation fails, or testOnBorrow is set to true and validation fails, the instance is destroyed and the next available instance is examined. This continues until either a valid instance is returned or there are no more idle instances available.
    
    If there are no idle instances available in the pool, behavior depends on the maxTotal, (if applicable) BaseGenericObjectPool.getBlockWhenExhausted() and the value passed in to the borrowMaxWaitMillis parameter. If the number of instances checked out from the pool is less than maxTotal, a new instance is created, activated and (if applicable) validated and returned to the caller. If validation fails, a NoSuchElementException is thrown.
    
    If the pool is exhausted (no available idle instances and no capacity to create new ones), this method will either block (if BaseGenericObjectPool.getBlockWhenExhausted() is true) or throw a NoSuchElementException (if BaseGenericObjectPool.getBlockWhenExhausted() is false). The length of time that this method will block when BaseGenericObjectPool.getBlockWhenExhausted() is true is determined by the value passed in to the borrowMaxWaitMillis parameter.
    
    When the pool is exhausted, multiple calling threads may be simultaneously blocked waiting for instances to become available. A "fairness" algorithm has been implemented to ensure that threads receive available instances in request arrival order.
    
    参数:
    
    borrowMaxWaitMillis - The time to wait in milliseconds for an object to become available
    
    返回:
    
    object instance from the pool
    
    抛出:
    
    java.util.NoSuchElementException - if an instance cannot be returned
    
    java.lang.Exception - if an object instance cannot be returned due to an error
  - clear
```
public void clear()
```
    Clears any objects sitting idle in the pool by removing them from the idle instance pool and then invoking the configured PooledObjectFactory.destroyObject(PooledObject) method on each idle instance.
    Implementation notes:
    - This method does not destroy or effect in any way instances that are checked out of the pool when it is invoked.
    - Invoking this method does not prevent objects being returned to the idle instance pool, even during its execution. Additional instances may be returned while removed items are being destroyed.
    - Exceptions encountered destroying idle instances are swallowed but notified via a SwallowedExceptionListener.
    指定者:
    
    clear 在接口中 ObjectPool<T>
  - close
```
public void close()
```
    Closes the pool. Once the pool is closed, borrowObject() will fail with IllegalStateException, but returnObject(Object) and invalidateObject(Object) will continue to work, with returned objects destroyed on return.
    Destroys idle instances in the pool by invoking clear().
    
    指定者:
    
    close 在接口中 java.io.Closeable
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
    
    指定者:
    
    close 在接口中 ObjectPool<T>
    
    指定者:
    
    close 在类中 BaseGenericObjectPool<T>
  - evict
```
public 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.
    
    Successive activations of this method examine objects in sequence, cycling through objects in oldest-to-youngest order.
    
    指定者:
    
    evict 在类中 BaseGenericObjectPool<T>
    
    抛出:
    
    java.lang.Exception - when there is a problem evicting idle objects.
  - getFactory
```
public PooledObjectFactory<T> getFactory()
```
    Gets a reference to the factory used to create, destroy and validate the objects used by this pool.
    
    返回:
    
    the factory
  - getFactoryType
```
public java.lang.String getFactoryType()
```
    Gets the type - including the specific type rather than the generic - of the factory.
    
    指定者:
    
    getFactoryType 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    A string representation of the factory type
  - getLogAbandoned
```
public boolean getLogAbandoned()
```
    Gets whether this pool identifies and logs any abandoned objects.
    
    指定者:
    
    getLogAbandoned 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    true if abandoned object removal is configured for this pool and removal events are to be logged otherwise false
    
    另请参阅:
    
    AbandonedConfig.getLogAbandoned()
  - getMaxIdle
```
public int getMaxIdle()
```
    Gets the cap on the number of "idle" instances in the pool. If maxIdle is set too low on heavily loaded systems it is possible you will see objects being destroyed and almost immediately new objects being created. This is a result of the active threads momentarily returning objects faster than they are requesting them, causing the number of idle objects to rise above maxIdle. The best value for maxIdle for heavily loaded system will vary but the default is a good starting point.
    
    指定者:
    
    getMaxIdle 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    the maximum number of "idle" instances that can be held in the pool or a negative value if there is no limit
    
    另请参阅:
    
    setMaxIdle(int)
  - getMinIdle
```
public int getMinIdle()
```
    Gets the target for the minimum number of idle objects to maintain in the pool. This setting only has an effect if it is positive and BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis() is greater than zero. If this is the case, an attempt is made to ensure that the pool has the required minimum number of instances during idle object eviction runs.
    If the configured value of minIdle is greater than the configured value for maxIdle then the value of maxIdle will be used instead.
    
    指定者:
    
    getMinIdle 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    The minimum number of objects.
    
    另请参阅:
    
    setMinIdle(int), setMaxIdle(int), BaseGenericObjectPool.setTimeBetweenEvictionRunsMillis(long)
  - getNumActive
```
public int getNumActive()
```
    从接口复制的说明: ObjectPool
    
    Gets the number of instances currently borrowed from this pool. Returns a negative value if this information is not available.
    
    指定者:
    
    getNumActive 在接口中 GenericObjectPoolMXBean
    
    指定者:
    
    getNumActive 在接口中 ObjectPool<T>
    
    返回:
    
    the number of instances currently borrowed from this pool.
  - getNumIdle
```
public int getNumIdle()
```
    从类复制的说明: BaseGenericObjectPool
    
    The number of instances currently idle in this pool.
    
    指定者:
    
    getNumIdle 在接口中 GenericObjectPoolMXBean
    
    指定者:
    
    getNumIdle 在接口中 ObjectPool<T>
    
    指定者:
    
    getNumIdle 在类中 BaseGenericObjectPool<T>
    
    返回:
    
    count of instances available for checkout from the pool
  - getNumWaiters
```
public int getNumWaiters()
```
    Gets an estimate of the number of threads currently blocked waiting for an object from the pool. This is intended for monitoring only, not for synchronization control.
    
    指定者:
    
    getNumWaiters 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    The estimate of the number of threads currently blocked waiting for an object from the pool
  - getRemoveAbandonedOnBorrow
```
public boolean getRemoveAbandonedOnBorrow()
```
    Gets whether a check is made for abandoned objects when an object is borrowed from this pool.
    
    指定者:
    
    getRemoveAbandonedOnBorrow 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    true if abandoned object removal is configured to be activated by borrowObject otherwise false
    
    另请参阅:
    
    AbandonedConfig.getRemoveAbandonedOnBorrow()
  - getRemoveAbandonedOnMaintenance
```
public boolean getRemoveAbandonedOnMaintenance()
```
    Gets whether a check is made for abandoned objects when the evictor runs.
    
    指定者:
    
    getRemoveAbandonedOnMaintenance 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    true if abandoned object removal is configured to be activated when the evictor runs otherwise false
    
    另请参阅:
    
    AbandonedConfig.getRemoveAbandonedOnMaintenance()
  - getRemoveAbandonedTimeout
```
@Deprecated
public int getRemoveAbandonedTimeout()
```
    已过时。 Use getRemoveAbandonedTimeoutDuration().
    
    Gets the timeout before which an object will be considered to be abandoned by this pool.
    
    指定者:
    
    getRemoveAbandonedTimeout 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    The abandoned object timeout in seconds if abandoned object removal is configured for this pool; Integer.MAX_VALUE otherwise.
    
    另请参阅:
    
    AbandonedConfig.getRemoveAbandonedTimeout(), AbandonedConfig.getRemoveAbandonedTimeoutDuration()
  - getRemoveAbandonedTimeoutDuration
```
public java.time.Duration getRemoveAbandonedTimeoutDuration()
```
    Gets the timeout before which an object will be considered to be abandoned by this pool.
    
    返回:
    
    The abandoned object timeout in seconds if abandoned object removal is configured for this pool; Integer.MAX_VALUE otherwise.
    
    另请参阅:
    
    AbandonedConfig.getRemoveAbandonedTimeout(), AbandonedConfig.getRemoveAbandonedTimeoutDuration()
  - invalidateObject
```
public void invalidateObject(T obj)
                      throws java.lang.Exception
```
    Invalidates an object from the pool.
    By contract, obj must have been obtained using ObjectPool.borrowObject() or a related method as defined in an implementation or sub-interface.
    
    This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid.
    
    Activation of this method decrements the active count and attempts to destroy the instance, using the default (NORMAL) DestroyMode.
    
    指定者:
    
    invalidateObject 在接口中 ObjectPool<T>
    
    参数:
    
    obj - a borrowed instance to be disposed.
    
    抛出:
    
    java.lang.Exception - if an exception occurs destroying the object
    
    java.lang.IllegalStateException - if obj does not belong to this pool
  - invalidateObject
```
public void invalidateObject(T obj,
                             DestroyMode mode)
                      throws java.lang.Exception
```
    Invalidates an object from the pool, using the provided DestroyMode
    By contract, obj must have been obtained using ObjectPool.borrowObject() or a related method as defined in an implementation or sub-interface.
    
    This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid.
    
    Activation of this method decrements the active count and attempts to destroy the instance, using the provided DestroyMode.
    
    指定者:
    
    invalidateObject 在接口中 ObjectPool<T>
    
    参数:
    
    obj - a borrowed instance to be disposed.
    
    mode - destroy activation context provided to the factory
    
    抛出:
    
    java.lang.Exception - if an exception occurs destroying the object
    
    java.lang.IllegalStateException - if obj does not belong to this pool
    
    从以下版本开始:
    
    2.9.0
  - isAbandonedConfig
```
public boolean isAbandonedConfig()
```
    Gets whether or not abandoned object removal is configured for this pool.
    
    指定者:
    
    isAbandonedConfig 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    true if this pool is configured to detect and remove abandoned objects
  - listAllObjects
```
public java.util.Set<DefaultPooledObjectInfo> listAllObjects()
```
    Provides information on all the objects in the pool, both idle (waiting to be borrowed) and active (currently borrowed).
    Note: This is named listAllObjects so it is presented as an operation via JMX. That means it won't be invoked unless the explicitly requested whereas all attributes will be automatically requested when viewing the attributes for an object in a tool like JConsole.
    
    指定者:
    
    listAllObjects 在接口中 GenericObjectPoolMXBean
    
    返回:
    
    Information grouped on all the objects in the pool
  - preparePool
```
public void preparePool()
                 throws java.lang.Exception
```
    Tries to ensure that getMinIdle() idle instances are available in the pool.
    
    抛出:
    
    java.lang.Exception - If the associated factory throws an exception
    
    从以下版本开始:
    
    2.4
  - returnObject
```
public void returnObject(T obj)
```
    Returns an instance to the pool. By contract, obj must have been obtained using ObjectPool.borrowObject() or a related method as defined in an implementation or sub-interface.
    If maxIdle is set to a positive value and the number of idle instances has reached this value, the returning instance is destroyed.
    
    If testOnReturn == true, the returning instance is validated before being returned to the idle instance pool. In this case, if validation fails, the instance is destroyed.
    
    Exceptions encountered destroying objects for any reason are swallowed but notified via a SwallowedExceptionListener.
    
    指定者:
    
    returnObject 在接口中 ObjectPool<T>
    
    参数:
    
    obj - a borrowed instance to be returned.
  - setAbandonedConfig
```
public void setAbandonedConfig(AbandonedConfig abandonedConfig)
```
    Sets the abandoned object removal configuration.
    
    参数:
    
    abandonedConfig - the new configuration to use. This is used by value.
    
    另请参阅:
    
    AbandonedConfig
  - setConfig
```
public void setConfig(GenericObjectPoolConfig<T> conf)
```
    Sets the base pool configuration.
    
    参数:
    
    conf - the new configuration to use. This is used by value.
    
    另请参阅:
    
    GenericObjectPoolConfig
  - setMaxIdle
```
public void setMaxIdle(int maxIdle)
```
    Sets the cap on the number of "idle" instances in the pool. If maxIdle is set too low on heavily loaded systems it is possible you will see objects being destroyed and almost immediately new objects being created. This is a result of the active threads momentarily returning objects faster than they are requesting them, causing the number of idle objects to rise above maxIdle. The best value for maxIdle for heavily loaded system will vary but the default is a good starting point.
    
    参数:
    
    maxIdle - The cap on the number of "idle" instances in the pool. Use a negative value to indicate an unlimited number of idle instances
    
    另请参阅:
    
    getMaxIdle()
  - setMinIdle
```
public void setMinIdle(int minIdle)
```
    Sets the target for the minimum number of idle objects to maintain in the pool. This setting only has an effect if it is positive and BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis() is greater than zero. If this is the case, an attempt is made to ensure that the pool has the required minimum number of instances during idle object eviction runs.
    If the configured value of minIdle is greater than the configured value for maxIdle then the value of maxIdle will be used instead.
    
    参数:
    
    minIdle - The minimum number of objects.
    
    另请参阅:
    
    getMinIdle(), getMaxIdle(), BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()
  - use
```
public void use(T pooledObject)
```
    从接口复制的说明: UsageTracking
    
    This method is called every time a pooled object is used to enable the pool to better track borrowed objects.
    
    指定者:
    
    use 在接口中 UsageTracking<T>
    
    参数:
    
    pooledObject - The object that is being used

类 GenericObjectPool<T>

字段概要

从类继承的字段 org.apache.commons.pool2.impl.BaseGenericObjectPool

构造器概要

方法概要

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

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

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

从接口继承的方法 org.apache.commons.pool2.ObjectPool

从接口继承的方法 org.apache.commons.pool2.impl.GenericObjectPoolMXBean

构造器详细资料

GenericObjectPool

GenericObjectPool

GenericObjectPool

方法详细资料

addObject

borrowObject

borrowObject

borrowObject

clear

close

evict

getFactory

getFactoryType

getLogAbandoned

getMaxIdle

getMinIdle

getNumActive

getNumIdle

getNumWaiters

getRemoveAbandonedOnBorrow

getRemoveAbandonedOnMaintenance

getRemoveAbandonedTimeout

getRemoveAbandonedTimeoutDuration

invalidateObject

invalidateObject

isAbandonedConfig

listAllObjects

preparePool

returnObject

setAbandonedConfig

setConfig

setMaxIdle

setMinIdle

use