StackObjectPool

java.lang.Object
- com.sh.pool.BaseObjectPool<T>
- - com.sh.pool.impl.StackObjectPool<T>

所有已实现的接口:

ObjectPool<T>
```
public class StackObjectPool<T>
extends BaseObjectPool<T>
implements ObjectPool<T>
```
Description: StackObjectPool Title:首亨软件 - CRM、TSS、ERP等信息化管理软件

版本:

3.0

作者:

江兴春

构造器概要

构造器
构造器和说明
`StackObjectPool()` 已过时。 to be removed in pool 2.0 - use `StackObjectPool(PoolableObjectFactory)`
`StackObjectPool(int maxIdle)` 已过时。 to be removed in pool 2.0 - use `StackObjectPool(PoolableObjectFactory, int)`
`StackObjectPool(int maxIdle, int initIdleCapacity)` 已过时。 to be removed in pool 2.0 - use `StackObjectPool(PoolableObjectFactory, int, int)`
`StackObjectPool(PoolableObjectFactory<T> factory)` Create a new `StackObjectPool` using the specified factory to create new instances.
`StackObjectPool(PoolableObjectFactory<T> factory, int maxIdle)` Create a new `SimpleObjectPool` using the specified factory to create new instances, capping the number of "sleeping" instances to maxIdle.
`StackObjectPool(PoolableObjectFactory<T> factory, int maxIdle, int initIdleCapacity)` Create a new `StackObjectPool` using the specified `factory` to create new instances, capping the number of "sleeping" instances to `maxIdle`, and initially allocating a container capable of containing at least `initIdleCapacity` instances.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addObject()` Create an object, and place it on top of the stack.
`T`	`borrowObject()` Borrows an object from the pool.
`void`	`clear()` Clears any objects sitting idle in the pool.
`void`	`close()` Close this pool, and free any resources associated with it.
`PoolableObjectFactory<T>`	`getFactory()` Returns the `PoolableObjectFactory` used by this pool to create and manage object instances.
`int`	`getMaxSleeping()` Returns the maximum number of idle instances in the pool.
`int`	`getNumActive()` Return the number of instances currently borrowed from this pool.
`int`	`getNumIdle()` Return the number of instances currently idle in this pool.
`void`	`invalidateObject(T obj)` Invalidates an object from the pool.
`void`	`returnObject(T obj)` Returns an instance to the pool.
`void`	`setFactory(PoolableObjectFactory<T> factory)` 已过时。 to be removed in pool 2.0

从类继承的方法 com.sh.pool.BaseObjectPool
isClosed

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

- 构造器详细资料
  - StackObjectPool
```
@Deprecated
public StackObjectPool()
```
    已过时。 to be removed in pool 2.0 - use StackObjectPool(PoolableObjectFactory)
    
    Create a new pool using no factory. Clients must first set the factory or else this pool will not behave correctly. Clients may first populate the pool using returnObject(java.lang.Object) before they can be borrowed but this usage is discouraged.
    
    另请参阅:
    
    StackObjectPool(PoolableObjectFactory)
  - StackObjectPool
```
@Deprecated
public StackObjectPool(int maxIdle)
```
    已过时。 to be removed in pool 2.0 - use StackObjectPool(PoolableObjectFactory, int)
    
    Create a new pool using no factory. Clients must first set the factory or else this pool will not behave correctly. Clients may first populate the pool using returnObject(java.lang.Object) before they can be borrowed but this usage is discouraged.
    
    参数:
    
    maxIdle - cap on the number of "sleeping" instances in the pool
    
    另请参阅:
    
    StackObjectPool(PoolableObjectFactory, int)
  - StackObjectPool
```
@Deprecated
public StackObjectPool(int maxIdle,
                                    int initIdleCapacity)
```
    已过时。 to be removed in pool 2.0 - use StackObjectPool(PoolableObjectFactory, int, int)
    
    Create a new pool using no factory. Clients must first set the factory or else this pool will not behave correctly. Clients may first populate the pool using returnObject(java.lang.Object) before they can be borrowed but this usage is discouraged.
    
    参数:
    
    maxIdle - cap on the number of "sleeping" instances in the pool
    
    initIdleCapacity - initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)
    
    另请参阅:
    
    StackObjectPool(PoolableObjectFactory, int, int)
  - StackObjectPool
```
public StackObjectPool(PoolableObjectFactory<T> factory)
```
    Create a new StackObjectPool using the specified factory to create new instances.
    
    参数:
    
    factory - the PoolableObjectFactory used to populate the pool
  - StackObjectPool
```
public StackObjectPool(PoolableObjectFactory<T> factory,
                       int maxIdle)
```
    Create a new SimpleObjectPool using the specified factory to create new instances, capping the number of "sleeping" instances to maxIdle.
    
    参数:
    
    factory - the PoolableObjectFactory used to populate the pool
    
    maxIdle - cap on the number of "sleeping" instances in the pool
  - StackObjectPool
```
public StackObjectPool(PoolableObjectFactory<T> factory,
                       int maxIdle,
                       int initIdleCapacity)
```
    Create a new StackObjectPool using the specified factory to create new instances, capping the number of "sleeping" instances to maxIdle, and initially allocating a container capable of containing at least initIdleCapacity instances. The pool is not pre-populated. The initIdleCapacity parameter just determines the initial size of the underlying container, which can increase beyond this value if maxIdle > initIdleCapacity.
    
    Negative values of maxIdle are ignored (i.e., the pool is created using DEFAULT_MAX_SLEEPING) as are non-positive values for initIdleCapacity.
    
    参数:
    
    factory - the PoolableObjectFactory used to populate the pool
    
    maxIdle - cap on the number of "sleeping" instances in the pool
    
    initIdleCapacity - initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)
- 方法详细资料
  - borrowObject
```
public T borrowObject()
               throws java.lang.Exception
```
    Borrows an object from the pool. If there are idle instances available on the stack, the top element of the stack is popped to activate, validate and return to the client. If there are no idle instances available, the makeObject method of the pool's PoolableObjectFactory is invoked to create a new instance.
    
    All instances are activated and validated before being returned to the client. If validation fails or an exception occurs activating or validating an instance popped from the idle instance stack, the failing instance is destroyed and the next instance on the stack is popped, validated and activated. This process continues until either the stack is empty or an instance passes validation. If the stack is empty on activation or it does not contain any valid instances, the factory's makeObject method is used to create a new instance. If a null instance is returned by the factory or the created instance either raises an exception on activation or fails validation, NoSuchElementException is thrown. Exceptions thrown by MakeObject are propagated to the caller; but other than ThreadDeath or VirtualMachineError, exceptions generated by activation, validation or destroy methods are swallowed silently.
    
    指定者:
    
    borrowObject 在接口中 ObjectPool<T>
    
    指定者:
    
    borrowObject 在类中 BaseObjectPool<T>
    
    返回:
    
    an instance from the pool
    
    抛出:
    
    java.lang.Exception - if an instance cannot be obtained from the pool
  - returnObject
```
public void returnObject(T obj)
                  throws java.lang.Exception
```
    从类复制的说明: BaseObjectPool
    
    Returns an instance to the pool.
    
    指定者:
    
    returnObject 在接口中 ObjectPool<T>
    
    指定者:
    
    returnObject 在类中 BaseObjectPool<T>
    
    参数:
    
    obj - instance to return to the pool
    
    抛出:
    
    java.lang.Exception
  - invalidateObject
```
public void invalidateObject(T obj)
                      throws java.lang.Exception
```
    Invalidates an object from the pool.
    
    By contract, obj must have been obtained using 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.
    
    指定者:
    
    invalidateObject 在接口中 ObjectPool<T>
    
    指定者:
    
    invalidateObject 在类中 BaseObjectPool<T>
    
    参数:
    
    obj - a borrowed instance to be disposed.
    
    抛出:
    
    java.lang.Exception - Exception
  - getNumIdle
```
public int getNumIdle()
```
    Return the number of instances currently idle in this pool.
    
    指定者:
    
    getNumIdle 在接口中 ObjectPool<T>
    
    覆盖:
    
    getNumIdle 在类中 BaseObjectPool<T>
    
    返回:
    
    the number of instances currently idle in this pool
  - getNumActive
```
public int getNumActive()
```
    Return the number of instances currently borrowed from this pool.
    
    指定者:
    
    getNumActive 在接口中 ObjectPool<T>
    
    覆盖:
    
    getNumActive 在类中 BaseObjectPool<T>
    
    返回:
    
    the number of instances currently borrowed from this pool
  - clear
```
public void clear()
```
    Clears any objects sitting idle in the pool. Silently swallows any exceptions thrown by PoolableObjectFactory.destroyObject(Object).
    
    指定者:
    
    clear 在接口中 ObjectPool<T>
    
    覆盖:
    
    clear 在类中 BaseObjectPool<T>
  - close
```
public void close()
           throws java.lang.Exception
```
    Close this pool, and free any resources associated with it. Invokes clear() to destroy and remove instances in the pool.
    
    Calling addObject() or borrowObject() after invoking this method on a pool will cause them to throw an IllegalStateException.
    
    指定者:
    
    close 在接口中 ObjectPool<T>
    
    覆盖:
    
    close 在类中 BaseObjectPool<T>
    
    抛出:
    
    java.lang.Exception - never - exceptions clearing the pool are swallowed
  - addObject
```
public void addObject()
               throws java.lang.Exception
```
    Create an object, and place it on top of the stack. This method is useful for "pre-loading" a pool with idle objects.
    
    Before being added to the pool, the newly created instance is validated and passivated. If validation fails, the new instance is destroyed. Exceptions generated by the factory makeObject or passivate are propagated to the caller. Exceptions destroying instances are silently swallowed.
    
    If a new instance is created and successfully validated and passivated and adding this instance to the pool causes maxSleeping to be exceeded, the oldest (bottom) instance in the pool is destroyed to make room for the newly created instance, which is pushed on top of the stack.
    
    指定者:
    
    addObject 在接口中 ObjectPool<T>
    
    覆盖:
    
    addObject 在类中 BaseObjectPool<T>
    
    抛出:
    
    java.lang.Exception - when the factory has a problem creating or passivating an object.
  - setFactory
```
@Deprecated
public void setFactory(PoolableObjectFactory<T> factory)
                             throws java.lang.IllegalStateException
```
    已过时。 to be removed in pool 2.0
    
    Sets the factory this pool uses to create new instances. Trying to change the factory while there are borrowed objects will throw an IllegalStateException.
    
    指定者:
    
    setFactory 在接口中 ObjectPool<T>
    
    覆盖:
    
    setFactory 在类中 BaseObjectPool<T>
    
    参数:
    
    factory - the PoolableObjectFactory used to create new instances.
    
    抛出:
    
    java.lang.IllegalStateException - when the factory cannot be set at this time
  - getFactory
```
public PoolableObjectFactory<T> getFactory()
```
    Returns the PoolableObjectFactory used by this pool to create and manage object instances.
    
    返回:
    
    the factory
    
    从以下版本开始:
    
    1.5.5
  - getMaxSleeping
```
public int getMaxSleeping()
```
    Returns the maximum number of idle instances in the pool.
    
    返回:
    
    maxSleeping
    
    从以下版本开始:
    
    1.5.5

类 StackObjectPool<T>

构造器概要

方法概要

从类继承的方法 com.sh.pool.BaseObjectPool

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

构造器详细资料

StackObjectPool

StackObjectPool

StackObjectPool

StackObjectPool

StackObjectPool

StackObjectPool

方法详细资料

borrowObject

returnObject

invalidateObject

getNumIdle

getNumActive

clear

close

addObject

setFactory

getFactory

getMaxSleeping