Package org.apache.commons.pool
Class PoolUtils.CheckedKeyedObjectPool<K,V>
java.lang.Object
org.apache.commons.pool.PoolUtils.CheckedKeyedObjectPool<K,V>
- All Implemented Interfaces:
KeyedObjectPool<K,
V>
- Enclosing class:
PoolUtils
private static class PoolUtils.CheckedKeyedObjectPool<K,V>
extends Object
implements KeyedObjectPool<K,V>
A keyed object pool that performs type checking on objects passed
to pool methods.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCheckedKeyedObjectPool
(KeyedObjectPool<K, V> keyedPool, Class<V> type) Create a new CheckedKeyedObjectPool from the given pool with given expected object type. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Create an object using thefactory
or other implementation dependent mechanism, passivate it, and then place it in the idle object pool.borrowObject
(K key) Borrow an object from the pool, verifying correct return type.void
clear()
Clears the pool, removing all pooled instances (optional operation).void
Clears the specified pool, removing all pooled instances corresponding to the givenkey
(optional operation).void
close()
Close this pool, and free any resources associated with it.int
Returns the total number of instances current borrowed from this pool but not yet returned (optional operation).int
getNumActive
(K key) Returns the number of instances currently borrowed from but not yet returned to the pool corresponding to the givenkey
(optional operation).int
Returns the total number of instances currently idle in this pool (optional operation).int
getNumIdle
(K key) Returns the number of instances corresponding to the givenkey
currently idle in this pool (optional operation).void
invalidateObject
(K key, V obj) Invalidate an object to the pool, checking its type.void
returnObject
(K key, V obj) Return an object to the pool, checking its type.void
setFactory
(KeyedPoolableObjectFactory<K, V> factory) Deprecated.to be removed in version 2.0toString()
-
Field Details
-
type
Expected type of objects managed by the pool. This should be a subtype of the return type of the object factory used by the pool. -
keyedPool
Underlying pool
-
-
Constructor Details
-
CheckedKeyedObjectPool
CheckedKeyedObjectPool(KeyedObjectPool<K, V> keyedPool, Class<V> type) Create a new CheckedKeyedObjectPool from the given pool with given expected object type.- Parameters:
keyedPool
- underlying pooltype
- expected object type- Throws:
IllegalArgumentException
- if either parameter is null
-
-
Method Details
-
borrowObject
Borrow an object from the pool, verifying correct return type.- Specified by:
borrowObject
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- pool key- Returns:
- type-checked object from the pool under the given key
- Throws:
ClassCastException
- if the object returned by the pool is not of the expected typeException
- whenmakeObject
throws an exceptionNoSuchElementException
- when the pool is exhausted and cannot or will not return another instanceIllegalStateException
- afterclose
has been called on this pool
-
returnObject
Return an object to the pool, checking its type.- Specified by:
returnObject
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the associated key (not type-checked)obj
- the object to return (type-checked)- Throws:
ClassCastException
- if obj is not of the expected type
-
invalidateObject
Invalidate an object to the pool, checking its type.- Specified by:
invalidateObject
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the associated key (not type-checked)obj
- the object to return (type-checked)- Throws:
ClassCastException
- if obj is not of the expected type
-
addObject
Create an object using thefactory
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).- Specified by:
addObject
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the key a new instance should be added to- Throws:
Exception
- whenKeyedPoolableObjectFactory.makeObject(K)
fails.IllegalStateException
- afterKeyedObjectPool.close()
has been called on this pool.UnsupportedOperationException
- when this pool cannot add new idle objects.
-
getNumIdle
Returns the number of instances corresponding to the givenkey
currently idle in this pool (optional operation). Returns a negative value if this information is not available.- Specified by:
getNumIdle
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the key to query- Returns:
- the number of instances corresponding to the given
key
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 number of instances currently borrowed from but not yet returned to the pool corresponding to the givenkey
(optional operation). Returns a negative value if this information is not available.- Specified by:
getNumActive
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the key to query- Returns:
- the number of instances corresponding to the given
key
currently borrowed in this pool or a negative value if unsupported - 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:
getNumIdle
in 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:
getNumActive
in 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). ThrowsUnsupportedOperationException
if the pool cannot be cleared.- Specified by:
clear
in interfaceKeyedObjectPool<K,
V> - Throws:
UnsupportedOperationException
- when this implementation doesn't support the operationException
-
clear
Clears the specified pool, removing all pooled instances corresponding to the givenkey
(optional operation). ThrowsUnsupportedOperationException
if the pool cannot be cleared.- Specified by:
clear
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the key to clear- 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
addObject
orborrowObject
after invoking this method on a pool will cause them to throw anIllegalStateException
.- Specified by:
close
in interfaceKeyedObjectPool<K,
V>
-
setFactory
@Deprecated public void setFactory(KeyedPoolableObjectFactory<K, V> factory) throws IllegalStateException, UnsupportedOperationExceptionDeprecated.to be removed in version 2.0Sets the object factory associated with the pool- Specified by:
setFactory
in interfaceKeyedObjectPool<K,
V> - Parameters:
factory
- object factory- Throws:
IllegalStateException
- when the factory cannot be set at this timeUnsupportedOperationException
- when this implementation doesn't support the operation
-
toString
-