private static class PoolUtils.ObjectPoolAdaptor<V> extends java.lang.Object implements ObjectPool<V>
Modifier and Type | Field and Description |
---|---|
private java.lang.Object |
key
Fixed key
|
private KeyedObjectPool<java.lang.Object,V> |
keyedPool
Underlying KeyedObjectPool
|
Constructor and Description |
---|
ObjectPoolAdaptor(KeyedObjectPool<java.lang.Object,V> keyedPool,
java.lang.Object key)
Create a new ObjectPoolAdaptor using the provided KeyedObjectPool and fixed key.
|
Modifier and Type | Method and Description |
---|---|
void |
addObject()
Create an object using the
factory or other
implementation dependent mechanism, passivate it, and then place it in the idle object pool. |
V |
borrowObject()
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 |
getNumActive()
Return the number of instances
currently borrowed from this pool
(optional operation).
|
int |
getNumIdle()
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.0
|
java.lang.String |
toString() |
private final java.lang.Object key
private final KeyedObjectPool<java.lang.Object,V> keyedPool
ObjectPoolAdaptor(KeyedObjectPool<java.lang.Object,V> keyedPool, java.lang.Object key) throws java.lang.IllegalArgumentException
keyedPool
- underlying KeyedObjectPoolkey
- fixed keyjava.lang.IllegalArgumentException
- if either of the parameters is nullpublic V borrowObject() throws java.lang.Exception, java.util.NoSuchElementException, java.lang.IllegalStateException
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 validated with validateObject
.
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 a NoSuchElementException
.
borrowObject
in interface ObjectPool<V>
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.public void returnObject(V obj)
obj
must have been obtained
using borrowObject
or a related method as defined in an implementation
or sub-interface.returnObject
in interface ObjectPool<V>
obj
- a borrowed
instance to be returned.public void invalidateObject(V obj)
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.
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
in interface ObjectPool<V>
obj
- a borrowed
instance to be disposed.public void addObject() throws java.lang.Exception, java.lang.IllegalStateException
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
in interface ObjectPool<V>
java.lang.Exception
- when PoolableObjectFactory.makeObject()
fails.java.lang.IllegalStateException
- after ObjectPool.close()
has been called on this pool.java.lang.UnsupportedOperationException
- when this pool cannot add new idle objects.public int getNumIdle() throws java.lang.UnsupportedOperationException
borrowed
without creating any new instances.
Returns a negative value if this information is not available.getNumIdle
in interface ObjectPool<V>
java.lang.UnsupportedOperationException
- deprecated: if this implementation does not support the operationpublic int getNumActive() throws java.lang.UnsupportedOperationException
getNumActive
in interface ObjectPool<V>
java.lang.UnsupportedOperationException
- deprecated: if this implementation does not support the operationpublic void clear() throws java.lang.Exception, java.lang.UnsupportedOperationException
destroyed
.clear
in interface ObjectPool<V>
java.lang.UnsupportedOperationException
- if this implementation does not support the operationjava.lang.Exception
public void close()
Calling ObjectPool.addObject()
or ObjectPool.borrowObject()
after invoking
this method on a pool will cause them to throw an
IllegalStateException
.
close
in interface ObjectPool<V>
@Deprecated public void setFactory(PoolableObjectFactory<V> factory) throws java.lang.IllegalStateException, java.lang.UnsupportedOperationException
setFactory
in interface ObjectPool<V>
factory
- new PoolableObjectFactoryjava.lang.IllegalStateException
- when the factory cannot be set at this timejava.lang.UnsupportedOperationException
- if this implementation does not support the operationpublic java.lang.String toString()
toString
in class java.lang.Object