StackKeyedObjectPool

java.lang.Object
- com.sh.pool.BaseKeyedObjectPool<K,V>
- - com.sh.pool.impl.StackKeyedObjectPool<K,V>

所有已实现的接口:

KeyedObjectPool<K,V>
```
public class StackKeyedObjectPool<K,V>
extends BaseKeyedObjectPool<K,V>
implements KeyedObjectPool<K,V>
```
Description: StackKeyedObjectPool Title:首亨软件 - CRM、TSS、ERP等信息化管理软件

版本:

3.0

作者:

江兴春

构造器概要

构造器
构造器和说明
`StackKeyedObjectPool()` Create a new pool using no factory.
`StackKeyedObjectPool(int max)` Create a new pool using no factory.
`StackKeyedObjectPool(int max, int init)` Create a new pool using no factory.
`StackKeyedObjectPool(KeyedPoolableObjectFactory<K,V> factory)` Create a new `SimpleKeyedObjectPool` using the specified `factory` to create new instances.
`StackKeyedObjectPool(KeyedPoolableObjectFactory<K,V> factory, int max)` Create a new `SimpleKeyedObjectPool` using the specified `factory` to create new instances.
`StackKeyedObjectPool(KeyedPoolableObjectFactory<K,V> factory, int max, int init)` Create a new `SimpleKeyedObjectPool` using the specified `factory` to create new instances.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addObject(K key)` Create an object using the `factory`, passivate it, and then placed in the idle object pool.
`V`	`borrowObject(K key)` Borrows an object with the given key.
`void`	`clear()` Clears the pool, removing all pooled instances.
`void`	`clear(K key)` Clears the specified pool, removing all pooled instances corresponding to the given `key`.
`void`	`close()` Close this pool, and free any resources associated with it.
`java.util.Map<K,java.lang.Integer>`	`getActiveCount()`
`KeyedPoolableObjectFactory<K,V>`	`getFactory()`
`int`	`getInitSleepingCapacity()`
`int`	`getMaxSleeping()`
`int`	`getNumActive()` Returns the total number of instances current borrowed from this pool but not yet returned.
`int`	`getNumActive(K key)` Returns the number of instances currently borrowed from but not yet returned to the pool corresponding to the given `key`.
`int`	`getNumIdle()` Returns the total number of instances currently idle in this pool.
`int`	`getNumIdle(K key)` Returns the number of instances corresponding to the given `key` currently idle in this pool.
`java.util.Map<K,java.util.Stack<V>>`	`getPools()`
`int`	`getTotActive()`
`int`	`getTotIdle()`
`void`	`invalidateObject(K key, V obj)` Invalidates an object from the pool.
`void`	`returnObject(K key, V obj)` Returns `obj` to the pool under `key`.
`void`	`setFactory(KeyedPoolableObjectFactory<K,V> factory)` 已过时。 to be removed in pool 2.0
`java.lang.String`	`toString()` Returns a string representation of this StackKeyedObjectPool, including the number of pools, the keys and the size of each keyed pool.

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

- 构造器详细资料
  - StackKeyedObjectPool
```
public StackKeyedObjectPool()
```
    Create a new pool using no factory. Clients must first set the factory or may populate the pool using returnObject before they can be borrowed.
    
    另请参阅:
    
    StackKeyedObjectPool(KeyedPoolableObjectFactory), setFactory(KeyedPoolableObjectFactory)
  - StackKeyedObjectPool
```
public StackKeyedObjectPool(int max)
```
    Create a new pool using no factory. Clients must first set the factory or may populate the pool using returnObject before they can be borrowed.
    
    参数:
    
    max - cap on the number of "sleeping" instances in the pool
    
    另请参阅:
    
    StackKeyedObjectPool(KeyedPoolableObjectFactory, int), setFactory(KeyedPoolableObjectFactory)
  - StackKeyedObjectPool
```
public StackKeyedObjectPool(int max,
                            int init)
```
    Create a new pool using no factory. Clients must first set the factory or may populate the pool using returnObject before they can be borrowed.
    
    参数:
    
    max - cap on the number of "sleeping" instances in the pool
    
    init - initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)
    
    另请参阅:
    
    StackKeyedObjectPool(KeyedPoolableObjectFactory, int, int), setFactory(KeyedPoolableObjectFactory)
  - StackKeyedObjectPool
```
public StackKeyedObjectPool(KeyedPoolableObjectFactory<K,V> factory)
```
    Create a new SimpleKeyedObjectPool using the specified factory to create new instances.
    
    参数:
    
    factory - the KeyedPoolableObjectFactory used to populate the pool
  - StackKeyedObjectPool
```
public StackKeyedObjectPool(KeyedPoolableObjectFactory<K,V> factory,
                            int max)
```
    Create a new SimpleKeyedObjectPool using the specified factory to create new instances. capping the number of "sleeping" instances to max
    
    参数:
    
    factory - the KeyedPoolableObjectFactory used to populate the pool
    
    max - cap on the number of "sleeping" instances in the pool
  - StackKeyedObjectPool
```
public StackKeyedObjectPool(KeyedPoolableObjectFactory<K,V> factory,
                            int max,
                            int init)
```
    Create a new SimpleKeyedObjectPool using the specified factory to create new instances. capping the number of "sleeping" instances to max, and initially allocating a container capable of containing at least init instances.
    
    参数:
    
    factory - the KeyedPoolableObjectFactory used to populate the pool
    
    max - cap on the number of "sleeping" instances in the pool
    
    init - initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)
- 方法详细资料
  - borrowObject
```
public V borrowObject(K key)
               throws java.lang.Exception
```
    Borrows an object with the given key. If there are no idle instances under the given key, a new one is created.
    
    指定者:
    
    borrowObject 在接口中 KeyedObjectPool<K,V>
    
    指定者:
    
    borrowObject 在类中 BaseKeyedObjectPool<K,V>
    
    参数:
    
    key - the pool key
    
    返回:
    
    keyed poolable object instance
    
    抛出:
    
    java.lang.IllegalStateException - after close has been called on this pool
    
    java.lang.Exception - when makeObject throws an exception
    
    java.util.NoSuchElementException - when the pool is exhausted and cannot or will not return another instance
  - returnObject
```
public void returnObject(K key,
                         V obj)
                  throws java.lang.Exception
```
    Returns obj to the pool under key. If adding the returning instance to the pool results in maxSleeping exceeded for the given key, the oldest instance in the idle object pool is destroyed to make room for the returning instance.
    
    指定者:
    
    returnObject 在接口中 KeyedObjectPool<K,V>
    
    指定者:
    
    returnObject 在类中 BaseKeyedObjectPool<K,V>
    
    参数:
    
    key - the pool key
    
    obj - returning instance
    
    抛出:
    
    java.lang.Exception - Exception
  - invalidateObject
```
public void invalidateObject(K key,
                             V obj)
                      throws java.lang.Exception
```
    Invalidates an object from the pool.
    
    By contract, obj must have been obtained using borrowObject using a key that is equivalent to the one used to borrow the Object in the first place.
    
    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 在接口中 KeyedObjectPool<K,V>
    
    指定者:
    
    invalidateObject 在类中 BaseKeyedObjectPool<K,V>
    
    参数:
    
    key - the key used to obtain the object
    
    obj - a borrowed instance to be returned.
    
    抛出:
    
    java.lang.Exception - Exception
  - addObject
```
public void addObject(K key)
               throws java.lang.Exception
```
    Create an object using the factory, passivate it, and then placed in the idle object pool. addObject is useful for "pre-loading" a pool with idle objects.
    
    指定者:
    
    addObject 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    addObject 在类中 BaseKeyedObjectPool<K,V>
    
    参数:
    
    key - the key a new instance should be added to
    
    抛出:
    
    java.lang.Exception - when KeyedPoolableObjectFactory.makeObject(K) fails.
    
    java.lang.IllegalStateException - when no factory has been set or after close() has been called on this pool.
  - getNumIdle
```
public int getNumIdle()
```
    Returns the total number of instances currently idle in this pool.
    
    指定者:
    
    getNumIdle 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    getNumIdle 在类中 BaseKeyedObjectPool<K,V>
    
    返回:
    
    the total number of instances currently idle in this pool
  - getNumActive
```
public int getNumActive()
```
    Returns the total number of instances current borrowed from this pool but not yet returned.
    
    指定者:
    
    getNumActive 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    getNumActive 在类中 BaseKeyedObjectPool<K,V>
    
    返回:
    
    the total number of instances currently borrowed from this pool
  - getNumActive
```
public int getNumActive(K key)
```
    Returns the number of instances currently borrowed from but not yet returned to the pool corresponding to the given key.
    
    指定者:
    
    getNumActive 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    getNumActive 在类中 BaseKeyedObjectPool<K,V>
    
    参数:
    
    key - the key to query
    
    返回:
    
    the number of instances corresponding to the given key currently borrowed in this pool
  - getNumIdle
```
public int getNumIdle(K key)
```
    Returns the number of instances corresponding to the given key currently idle in this pool.
    
    指定者:
    
    getNumIdle 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    getNumIdle 在类中 BaseKeyedObjectPool<K,V>
    
    参数:
    
    key - the key to query
    
    返回:
    
    the number of instances corresponding to the given key currently idle in this pool
  - clear
```
public void clear()
```
    Clears the pool, removing all pooled instances.
    
    指定者:
    
    clear 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    clear 在类中 BaseKeyedObjectPool<K,V>
  - clear
```
public void clear(K key)
```
    Clears the specified pool, removing all pooled instances corresponding to the given key.
    
    指定者:
    
    clear 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    clear 在类中 BaseKeyedObjectPool<K,V>
    
    参数:
    
    key - the key to clear
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this StackKeyedObjectPool, including the number of pools, the keys and the size of each keyed pool.
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    Keys and pool sizes
  - close
```
public void close()
           throws java.lang.Exception
```
    Close this pool, and free any resources associated with it.
    Calling addObject or borrowObject after invoking this method on a pool will cause them to throw an IllegalStateException.
    
    指定者:
    
    close 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    close 在类中 BaseKeyedObjectPool<K,V>
    
    抛出:
    
    java.lang.Exception - deprecated: implementations should silently fail if not all resources can be freed.
  - setFactory
```
@Deprecated
public void setFactory(KeyedPoolableObjectFactory<K,V> factory)
                             throws java.lang.IllegalStateException
```
    已过时。 to be removed in pool 2.0
    
    Sets the factory the pool uses to create new instances. Trying to change the factory after a pool has been used will frequently throw an UnsupportedOperationException.
    
    指定者:
    
    setFactory 在接口中 KeyedObjectPool<K,V>
    
    覆盖:
    
    setFactory 在类中 BaseKeyedObjectPool<K,V>
    
    参数:
    
    factory - the KeyedPoolableObjectFactory used to manage object instances
    
    抛出:
    
    java.lang.IllegalStateException - when the factory cannot be set at this time
  - getFactory
```
public KeyedPoolableObjectFactory<K,V> getFactory()
```
    返回:
    
    the KeyedPoolableObjectFactory used by this pool to manage object instances.
    
    从以下版本开始:
    
    1.5.5
  - getPools
```
public java.util.Map<K,java.util.Stack<V>> getPools()
```
    返回:
    
    map of keyed pools
    
    从以下版本开始:
    
    1.5.5
  - getMaxSleeping
```
public int getMaxSleeping()
```
    返回:
    
    the cap on the number of "sleeping" instances in each pool.
    
    从以下版本开始:
    
    1.5.5
  - getInitSleepingCapacity
```
public int getInitSleepingCapacity()
```
    返回:
    
    the initial capacity of each pool.
    
    从以下版本开始:
    
    1.5.5
  - getTotActive
```
public int getTotActive()
```
    返回:
    
    the _totActive
  - getTotIdle
```
public int getTotIdle()
```
    返回:
    
    the _totIdle
  - getActiveCount
```
public java.util.Map<K,java.lang.Integer> getActiveCount()
```
    返回:
    
    the _activeCount
    
    从以下版本开始:
    
    1.5.5

类 StackKeyedObjectPool<K,V>

构造器概要

方法概要

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

构造器详细资料

StackKeyedObjectPool

StackKeyedObjectPool

StackKeyedObjectPool

StackKeyedObjectPool

StackKeyedObjectPool

StackKeyedObjectPool

方法详细资料

borrowObject

returnObject

invalidateObject

addObject

getNumIdle

getNumActive

getNumActive

getNumIdle

clear

clear

toString

close

setFactory

getFactory

getPools

getMaxSleeping

getInitSleepingCapacity

getTotActive

getTotIdle

getActiveCount