|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.pool.BaseKeyedObjectPool<K,V>
K
- the type of keys in this poolV
- the type of objects held in this poolpublic abstract class BaseKeyedObjectPool<K,V>
A simple base implementation of KeyedObjectPool
.
Optional operations are implemented to either do nothing, return a value
indicating it is unsupported or throw UnsupportedOperationException
.
Constructor Summary | |
---|---|
BaseKeyedObjectPool()
|
Method Summary | |
---|---|
void |
addObject(K key)
Not supported in this base implementation. |
abstract V |
borrowObject(K key)
Obtains an instance from this pool for the specified key . |
void |
clear()
Not supported in this base implementation. |
void |
clear(K key)
Not supported in this base implementation. |
void |
close()
Close this pool. |
int |
getNumActive()
Not supported in this base implementation. |
int |
getNumActive(K key)
Not supported in this base implementation. |
int |
getNumIdle()
Not supported in this base implementation. |
int |
getNumIdle(K key)
Not supported in this base implementation. |
abstract void |
invalidateObject(K key,
V obj)
Invalidates an object from the pool. |
abstract void |
returnObject(K key,
V obj)
Return an instance to the pool. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseKeyedObjectPool()
Method Detail |
---|
public void addObject(K key) throws Exception, UnsupportedOperationException
UnsupportedOperationException
,
subclasses should override this behavior.
addObject
in interface KeyedObjectPool<K,V>
key
- ignored
UnsupportedOperationException
Exception
- when KeyedPoolableObjectFactory.makeObject(K)
fails.
IllegalStateException
- after KeyedObjectPool.close()
has been called on this pool.public abstract V borrowObject(K key) throws Exception
key
.
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 object using
returnObject
, invalidateObject
, or a related method
as defined in an implementation or sub-interface,
using a key
that is equivalent
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 a NoSuchElementException
.
borrowObject
in interface KeyedObjectPool<K,V>
key
- the key used to obtain the object
IllegalStateException
- after close
has been called on this pool
Exception
- when makeObject
throws an exception
NoSuchElementException
- when the pool is exhausted and cannot or will not return another instancepublic void clear() throws Exception, UnsupportedOperationException
clear
in interface KeyedObjectPool<K,V>
UnsupportedOperationException
Exception
public void clear(K key) throws Exception, UnsupportedOperationException
clear
in interface KeyedObjectPool<K,V>
key
- ignored
UnsupportedOperationException
Exception
public void close() throws Exception
isClosed
and assertOpen
.
close
in interface KeyedObjectPool<K,V>
Exception
public int getNumActive() throws UnsupportedOperationException
getNumActive
in interface KeyedObjectPool<K,V>
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumActive(K key) throws UnsupportedOperationException
getNumActive
in interface KeyedObjectPool<K,V>
key
- ignored
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumIdle() throws UnsupportedOperationException
getNumIdle
in interface KeyedObjectPool<K,V>
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumIdle(K key) throws UnsupportedOperationException
getNumIdle
in interface KeyedObjectPool<K,V>
key
- ignored
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic abstract void invalidateObject(K key, V obj) throws Exception
Invalidates an object from the pool.
By contract, obj
must have been obtained
using borrowObject
using a key
that is
equivalent to the one used to borrow the Object
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.
invalidateObject
in interface KeyedObjectPool<K,V>
key
- the key used to obtain the objectobj
- a borrowed
instance to be returned.
Exception
public abstract void returnObject(K key, V obj) throws Exception
obj
must have been obtained
using borrowObject
or a related method as defined in an implementation
or sub-interface
using a key
that is equivalent to the one used to
borrow the instance in the first place.
returnObject
in interface KeyedObjectPool<K,V>
key
- the key used to obtain the objectobj
- a borrowed
instance to be returned.
Exception
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |