org.apache.commons.pool2.proxy

类 ProxiedKeyedObjectPool<K,V>

java.lang.Object

org.apache.commons.pool2.proxy.ProxiedKeyedObjectPool<K,V>

类型参数:

K - type of the key

V - type of the pooled object

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, KeyedObjectPool<K,V>

public class ProxiedKeyedObjectPool<K,V>
extends java.lang.Object
implements KeyedObjectPool<K,V>

Create a new keyed object pool where the pooled objects are wrapped in proxies allowing better control of pooled objects and in particular the prevention of the continued use of an object by a client after that client returns the object to the pool.

从以下版本开始:

2.0

构造器概要

构造器

构造器和说明
ProxiedKeyedObjectPool(KeyedObjectPool<K,V> pool, org.apache.commons.pool2.proxy.ProxySource<V> proxySource) Create a new proxied object pool.

方法概要

限定符和类型	方法和说明
void	addObject(K key) Create an object using the factory or other implementation dependent mechanism, passivate it, and then place it in the idle object pool.
V	borrowObject(K key) Borrows an instance from this pool for the specified key.
void	clear() Clears the pool, removing all pooled instances (optional operation).
void	clear(K key) Clears the specified pool, removing all pooled instances corresponding to the given key (optional operation).
void	close() Close this pool, and free any resources associated with it.
int	getNumActive() Gets the total number of instances currently borrowed from this pool but not yet returned.
int	getNumActive(K key) Gets the number of instances currently borrowed from but not yet returned to the pool corresponding to the given key.
int	getNumIdle() Gets the total number of instances currently idle in this pool.
int	getNumIdle(K key) Gets the number of instances corresponding to the given key currently idle in this pool.
void	invalidateObject(K key, V proxy) Invalidates an object from the pool.
void	returnObject(K key, V proxy) Return an instance to the pool.
java.lang.String	toString()

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addObjects, addObjects, invalidateObject

构造器详细资料

ProxiedKeyedObjectPool

public ProxiedKeyedObjectPool(KeyedObjectPool<K,V> pool,
                              org.apache.commons.pool2.proxy.ProxySource<V> proxySource)

Create a new proxied object pool.

参数:

pool - The object pool to wrap

proxySource - The source of the proxy objects

方法详细资料

addObject

public void addObject(K key)
               throws java.lang.Exception,
                      java.lang.IllegalStateException,
                      java.lang.UnsupportedOperationException

从接口复制的说明: KeyedObjectPool

Create an object using the factory or other implementation dependent mechanism, passivate it, and then place it in the idle object pool. addObject is useful for "pre-loading" a pool with idle objects (Optional operation).

指定者:

addObject 在接口中 KeyedObjectPool<K,V>

参数:

key - the key a new instance should be added to

抛出:

java.lang.Exception - when KeyedPooledObjectFactory.makeObject(K) fails.

java.lang.IllegalStateException - after KeyedObjectPool.close() has been called on this pool.

java.lang.UnsupportedOperationException - when this pool cannot add new idle objects.

borrowObject

public V borrowObject(K key)
               throws java.lang.Exception,
                      java.util.NoSuchElementException,
                      java.lang.IllegalStateException

从接口复制的说明: KeyedObjectPool

Borrows an instance from this pool for the specified key.

Instances returned from this method will have been either newly created with makeObject or will be a previously idle object and have been activated with activateObject and then (optionally) validated with validateObject.

By contract, clients must return the borrowed object using returnObject, invalidateObject, or a related method as defined in an implementation or sub-interface, using a key that is equivalent to the one used to borrow the instance in the first place.

The behavior of this method when the pool has been exhausted is not strictly specified (although it may be specified by implementations).

指定者:

borrowObject 在接口中 KeyedObjectPool<K,V>

参数:

key - the key used to obtain the object

返回:

an instance from this pool.

抛出:

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

clear

public void clear()
           throws java.lang.Exception,
                  java.lang.UnsupportedOperationException

从接口复制的说明: KeyedObjectPool

Clears the pool, removing all pooled instances (optional operation).

指定者:

clear 在接口中 KeyedObjectPool<K,V>

抛出:

java.lang.UnsupportedOperationException - when this implementation doesn't support the operation

java.lang.Exception - if the pool cannot be cleared

clear

public void clear(K key)
           throws java.lang.Exception,
                  java.lang.UnsupportedOperationException

从接口复制的说明: KeyedObjectPool

Clears the specified pool, removing all pooled instances corresponding to the given key (optional operation).

指定者:

clear 在接口中 KeyedObjectPool<K,V>

参数:

key - the key to clear

抛出:

java.lang.UnsupportedOperationException - when this implementation doesn't support the operation

java.lang.Exception - if the key cannot be cleared

close

public void close()

从接口复制的说明: KeyedObjectPool

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.

Implementations should silently fail if not all resources can be freed.

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

指定者:

close 在接口中 KeyedObjectPool<K,V>

getNumActive

public int getNumActive()

从接口复制的说明: KeyedObjectPool

Gets the total number of instances currently borrowed from this pool but not yet returned. Returns a negative value if this information is not available.

指定者:

getNumActive 在接口中 KeyedObjectPool<K,V>

返回:

the total number of instances currently borrowed from this pool but not yet returned.

getNumActive

public int getNumActive(K key)

从接口复制的说明: KeyedObjectPool

Gets the number of instances currently borrowed from but not yet returned to the pool corresponding to the given key. Returns a negative value if this information is not available.

指定者:

getNumActive 在接口中 KeyedObjectPool<K,V>

参数:

key - the key to query

返回:

the number of instances currently borrowed from but not yet returned to the pool corresponding to the given key.

getNumIdle

public int getNumIdle()

从接口复制的说明: KeyedObjectPool

Gets the total number of instances currently idle in this pool. Returns a negative value if this information is not available.

指定者:

getNumIdle 在接口中 KeyedObjectPool<K,V>

返回:

the total number of instances currently idle in this pool.

getNumIdle

public int getNumIdle(K key)

从接口复制的说明: KeyedObjectPool

Gets the number of instances corresponding to the given key currently idle in this pool. Returns a negative value if this information is not available.

指定者:

getNumIdle 在接口中 KeyedObjectPool<K,V>

参数:

key - the key to query

返回:

the number of instances corresponding to the given key currently idle in this pool.

invalidateObject

public void invalidateObject(K key,
                             V proxy)
                      throws java.lang.Exception

从接口复制的说明: KeyedObjectPool

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 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>

参数:

key - the key used to obtain the object

proxy - a borrowed instance to be returned.

抛出:

java.lang.Exception - if the instance cannot be invalidated

returnObject

public void returnObject(K key,
                         V proxy)
                  throws java.lang.Exception

从接口复制的说明: KeyedObjectPool

Return an instance to the pool. By contract, obj must have been obtained using borrowObject or a related method as defined in an implementation or sub-interface using a key that is equivalent to the one used to borrow the instance in the first place.

指定者:

returnObject 在接口中 KeyedObjectPool<K,V>

参数:

key - the key used to obtain the object

proxy - a borrowed instance to be returned.

抛出:

java.lang.IllegalStateException - if an attempt is made to return an object to the pool that is in any state other than allocated (i.e. borrowed). Attempting to return an object more than once or attempting to return an object that was never borrowed from the pool will trigger this exception.

java.lang.Exception - if an instance cannot be returned to the pool

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

从以下版本开始:

2.4.3