Class PoolUtils.KeyedObjectPoolAdaptor<K,V>
java.lang.Object
org.apache.commons.pool.PoolUtils.KeyedObjectPoolAdaptor<K,V>
- All Implemented Interfaces:
KeyedObjectPool<K,V>
- Enclosing class:
PoolUtils
private static class PoolUtils.KeyedObjectPoolAdaptor<K,V>
extends Object
implements KeyedObjectPool<K,V>
Adapts an ObjectPool to implement KeyedObjectPool by ignoring key arguments.
- Since:
- Pool 1.3
- Version:
- $Revision: 1222670 $ $Date: 2011-12-23 08:18:25 -0500 (Fri, 23 Dec 2011) $
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionKeyedObjectPoolAdaptor(ObjectPool<V> pool) Create a new KeyedObjectPoolAdaptor wrapping the given ObjectPool -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd an object to the pool, ignoring the keyborrowObject(K key) Borrow and object from the pool, ignoring the keyvoidclear()Clears the pool, removing all pooled instances (optional operation).voidClear the pool, ignoring the key (has same effect asclear().voidclose()Close this pool, and free any resources associated with it.intReturns the total number of instances current borrowed from this pool but not yet returned (optional operation).intgetNumActive(K key) Return the number of objects checked out from the pool, ignoring the key.intReturns the total number of instances currently idle in this pool (optional operation).intgetNumIdle(K key) Return the number of objects idle in the pool, ignoring the key.voidinvalidateObject(K key, V obj) Invalidate and object, ignoring the keyvoidreturnObject(K key, V obj) Return and object to the pool, ignoring the keyvoidsetFactory(KeyedPoolableObjectFactory<K, V> factory) Deprecated.to be removed in version 2.0toString()
-
Field Details
-
pool
Underlying pool
-
-
Constructor Details
-
KeyedObjectPoolAdaptor
KeyedObjectPoolAdaptor(ObjectPool<V> pool) throws IllegalArgumentException Create a new KeyedObjectPoolAdaptor wrapping the given ObjectPool- Parameters:
pool- underlying object pool- Throws:
IllegalArgumentException- if pool is null
-
-
Method Details
-
borrowObject
Borrow and object from the pool, ignoring the key- Specified by:
borrowObjectin interfaceKeyedObjectPool<K,V> - Parameters:
key- ignored- Returns:
- newly created object instance
- Throws:
Exception- whenmakeObjectthrows an exceptionNoSuchElementException- when the pool is exhausted and cannot or will not return another instanceIllegalStateException- afterclosehas been called on this pool
-
returnObject
Return and object to the pool, ignoring the key- Specified by:
returnObjectin interfaceKeyedObjectPool<K,V> - Parameters:
key- ignoredobj- object to return
-
invalidateObject
Invalidate and object, ignoring the key- Specified by:
invalidateObjectin interfaceKeyedObjectPool<K,V> - Parameters:
key- ignoredobj- object to invalidate
-
addObject
Add an object to the pool, ignoring the key- Specified by:
addObjectin interfaceKeyedObjectPool<K,V> - Parameters:
key- ignored- Throws:
Exception- whenKeyedPoolableObjectFactory.makeObject(K)fails.IllegalStateException- afterKeyedObjectPool.close()has been called on this pool.
-
getNumIdle
Return the number of objects idle in the pool, ignoring the key.- Specified by:
getNumIdlein interfaceKeyedObjectPool<K,V> - Parameters:
key- ignored- Returns:
- idle instance count
- Throws:
UnsupportedOperationException- deprecated: when this implementation doesn't support the operation
-
getNumActive
Return the number of objects checked out from the pool, ignoring the key.- Specified by:
getNumActivein interfaceKeyedObjectPool<K,V> - Parameters:
key- ignored- Returns:
- active instance count
- Throws:
UnsupportedOperationException- deprecated: when this implementation doesn't support the operation
-
getNumIdle
Returns the total number of instances currently idle in this pool (optional operation). Returns a negative value if this information is not available.- Specified by:
getNumIdlein interfaceKeyedObjectPool<K,V> - Returns:
- the total number of instances currently idle in this pool or a negative value if unsupported
- Throws:
UnsupportedOperationException- deprecated: when this implementation doesn't support the operation
-
getNumActive
Returns the total number of instances current borrowed from this pool but not yet returned (optional operation). Returns a negative value if this information is not available.- Specified by:
getNumActivein interfaceKeyedObjectPool<K,V> - Returns:
- the total number of instances currently borrowed from this pool or a negative value if unsupported
- Throws:
UnsupportedOperationException- deprecated: when this implementation doesn't support the operation
-
clear
Clears the pool, removing all pooled instances (optional operation). ThrowsUnsupportedOperationExceptionif the pool cannot be cleared.- Specified by:
clearin interfaceKeyedObjectPool<K,V> - Throws:
UnsupportedOperationException- when this implementation doesn't support the operationException
-
clear
Clear the pool, ignoring the key (has same effect asclear().- Specified by:
clearin interfaceKeyedObjectPool<K,V> - Parameters:
key- ignored.- Throws:
UnsupportedOperationException- when this implementation doesn't support the operationException
-
close
public void close()Close this pool, and free any resources associated with it.Calling
addObjectorborrowObjectafter invoking this method on a pool will cause them to throw anIllegalStateException.- Specified by:
closein interfaceKeyedObjectPool<K,V>
-
setFactory
@Deprecated public void setFactory(KeyedPoolableObjectFactory<K, V> factory) throws IllegalStateException, UnsupportedOperationExceptionDeprecated.to be removed in version 2.0Sets the factory used to manage objects.- Specified by:
setFactoryin interfaceKeyedObjectPool<K,V> - Parameters:
factory- new factory to use managing object instances- Throws:
IllegalStateException- when the factory cannot be set at this timeUnsupportedOperationException- when this implementation doesn't support the operation
-
toString
-