Class PoolUtils.ObjectPoolAdaptor<V>
- All Implemented Interfaces:
ObjectPool<V>
- Enclosing class:
- PoolUtils
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionObjectPoolAdaptor
(KeyedObjectPool<Object, V> keyedPool, Object key) Create a new ObjectPoolAdaptor using the provided KeyedObjectPool and fixed key. -
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.Obtains an instance from this pool.void
clear()
Clears any objects sitting idle in the pool, releasing any associated resources (optional operation).void
close()
Close this pool, and free any resources associated with it.int
Return the number of instances currently borrowed from this pool (optional operation).int
Return the number of instances currently idle in this pool (optional operation).void
invalidateObject
(V obj) Invalidates an object from the pool.void
returnObject
(V obj) Return an instance to the pool.void
setFactory
(PoolableObjectFactory<V> factory) Deprecated.to be removed in version 2.0toString()
-
Field Details
-
key
Fixed key -
keyedPool
Underlying KeyedObjectPool
-
-
Constructor Details
-
ObjectPoolAdaptor
ObjectPoolAdaptor(KeyedObjectPool<Object, V> keyedPool, Object key) throws IllegalArgumentExceptionCreate a new ObjectPoolAdaptor using the provided KeyedObjectPool and fixed key.- Parameters:
keyedPool
- underlying KeyedObjectPoolkey
- fixed key- Throws:
IllegalArgumentException
- if either of the parameters is null
-
-
Method Details
-
borrowObject
Obtains an instance from this pool.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 instance using
returnObject
,invalidateObject
, or a related method as defined in an implementation or sub-interface.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 interfaceObjectPool<V>
- Returns:
- an instance from this pool.
- Throws:
IllegalStateException
- afterclose
has been called on this pool.Exception
- whenmakeObject
throws an exception.NoSuchElementException
- when the pool is exhausted and cannot or will not return another instance.
-
returnObject
Return an instance to the pool. By contract,obj
must have been obtained usingborrowObject
or a related method as defined in an implementation or sub-interface.- Specified by:
returnObject
in interfaceObjectPool<V>
- Parameters:
obj
- aborrowed
instance to be returned.
-
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.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 interfaceObjectPool<V>
- Parameters:
obj
- aborrowed
instance to be disposed.
-
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 interfaceObjectPool<V>
- Throws:
Exception
- whenPoolableObjectFactory.makeObject()
fails.IllegalStateException
- afterObjectPool.close()
has been called on this pool.UnsupportedOperationException
- when this pool cannot add new idle objects.
-
getNumIdle
Return the number of instances currently idle in this pool (optional operation). This may be considered an approximation of the number of objects that can beborrowed
without creating any new instances. Returns a negative value if this information is not available.- Specified by:
getNumIdle
in interfaceObjectPool<V>
- Returns:
- the number of instances currently idle in this pool or a negative value if unsupported
- Throws:
UnsupportedOperationException
- deprecated: if this implementation does not support the operation
-
getNumActive
Return the number of instances currently borrowed from this pool (optional operation). Returns a negative value if this information is not available.- Specified by:
getNumActive
in interfaceObjectPool<V>
- Returns:
- the number of instances currently borrowed from this pool or a negative value if unsupported
- Throws:
UnsupportedOperationException
- deprecated: if this implementation does not support the operation
-
clear
Clears any objects sitting idle in the pool, releasing any associated resources (optional operation). Idle objects cleared must bedestroyed
.- Specified by:
clear
in interfaceObjectPool<V>
- Throws:
UnsupportedOperationException
- if this implementation does not support the operationException
-
close
public void close()Close this pool, and free any resources associated with it.Calling
ObjectPool.addObject()
orObjectPool.borrowObject()
after invoking this method on a pool will cause them to throw anIllegalStateException
.- Specified by:
close
in interfaceObjectPool<V>
-
setFactory
@Deprecated public void setFactory(PoolableObjectFactory<V> factory) throws IllegalStateException, UnsupportedOperationException Deprecated.to be removed in version 2.0Sets the PoolableObjectFactory for the pool.- Specified by:
setFactory
in interfaceObjectPool<V>
- Parameters:
factory
- new PoolableObjectFactory- Throws:
IllegalStateException
- when the factory cannot be set at this timeUnsupportedOperationException
- if this implementation does not support the operation
-
toString
-