Class PoolUtils.ErodingKeyedObjectPool<K,V>
- All Implemented Interfaces:
KeyedObjectPool<K,
V>
- Direct Known Subclasses:
PoolUtils.ErodingPerKeyKeyedObjectPool
- Enclosing class:
PoolUtils
invalid reference
erosion factor
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final PoolUtils.ErodingFactor
Erosion factorprivate final KeyedObjectPool
<K, V> Underlying pool -
Constructor Summary
ConstructorsModifierConstructorDescriptionErodingKeyedObjectPool
(KeyedObjectPool<K, V> keyedPool, float factor) Create an ErodingObjectPool wrapping the given pool using the specified erosion factor.protected
ErodingKeyedObjectPool
(KeyedObjectPool<K, V> keyedPool, PoolUtils.ErodingFactor erodingFactor) Create an ErodingObjectPool wrapping the given pool using the specified erosion factor. -
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) Obtains an instance from this pool for the specifiedkey
.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.protected PoolUtils.ErodingFactor
getErodingFactor
(K key) Returns the eroding factor for the given keyprotected KeyedObjectPool
<K, V> Returns the underlying poolint
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) Invalidates an object from the pool.protected int
Returns the total number of instances currently idle in this pool (optional operation).void
returnObject
(K key, V obj) Returns obj to the pool, unless erosion is triggered, in which case obj is invalidated.void
setFactory
(KeyedPoolableObjectFactory<K, V> factory) Deprecated.to be removed in pool 2.0toString()
-
Field Details
-
keyedPool
Underlying pool -
erodingFactor
Erosion factor
-
-
Constructor Details
-
ErodingKeyedObjectPool
Create an ErodingObjectPool wrapping the given pool using the specified erosion factor.- Parameters:
keyedPool
- underlying poolfactor
- erosion factor - determines the frequency of erosion events- See Also:
-
ErodingKeyedObjectPool
protected ErodingKeyedObjectPool(KeyedObjectPool<K, V> keyedPool, PoolUtils.ErodingFactor erodingFactor) Create an ErodingObjectPool wrapping the given pool using the specified erosion factor.- Parameters:
keyedPool
- underlying pool - must not be nullerodingFactor
- erosion factor - determines the frequency of erosion events- See Also:
-
-
Method Details
-
borrowObject
Obtains an instance from this pool for the specifiedkey
.Instances returned from this method will have been either newly created with
makeObject
or will be a previously idle object and have been activated withactivateObject
and then validated withvalidateObject
.By contract, clients must return the borrowed object using
returnObject
,invalidateObject
, or a related method as defined in an implementation or sub-interface, using akey
that isequivalent
to the one used to borrow the instance in the first place.The behaviour of this method when the pool has been exhausted is not strictly specified (although it may be specified by implementations). Older versions of this method would return
null
to indicate exhaustion, newer versions are encouraged to throw aNoSuchElementException
.- Specified by:
borrowObject
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the key used to obtain the object- Returns:
- an instance from this pool.
- Throws:
Exception
- 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
Returns obj to the pool, unless erosion is triggered, in which case obj is invalidated. Erosion is triggered when there are idle instances in the pool associated with the given key and more than the configurederosion factor
time has elapsed since the last returnObject activation.- Specified by:
returnObject
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- keyobj
- object to return or invalidate- Throws:
Exception
- See Also:
-
numIdle
Returns the total number of instances currently idle in this pool (optional operation). Returns a negative value if this information is not available.- Parameters:
key
- ignored- 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
-
getErodingFactor
Returns the eroding factor for the given key- Parameters:
key
- key- Returns:
- eroding factor for the given keyed pool
-
invalidateObject
Invalidates an object from the pool.
By contract,
obj
must have been obtained usingborrowObject
or a related method as defined in an implementation or sub-interface using akey
that is equivalent to the one used to borrow theObject
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.
- Specified by:
invalidateObject
in interfaceKeyedObjectPool<K,
V> - Parameters:
key
- the key used to obtain the objectobj
- aborrowed
instance to be returned.
-
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 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
-
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 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
-
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
-
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 pool 2.0Sets thefactory
the pool uses to create new instances (optional operation). Trying to change thefactory
after a pool has been used will frequently throw anUnsupportedOperationException
. It is up to the pool implementation to determine when it is acceptable to call this method.- Specified by:
setFactory
in interfaceKeyedObjectPool<K,
V> - Parameters:
factory
- theKeyedPoolableObjectFactory
used to create new instances.- Throws:
IllegalStateException
- when the factory cannot be set at this timeUnsupportedOperationException
- when this implementation doesn't support the operation
-
getKeyedPool
Returns the underlying pool- Returns:
- the keyed pool that this ErodingKeyedObjectPool wraps
-
toString
-