public abstract class BaseKeyedObjectPool extends Object implements KeyedObjectPool
KeyedObjectPool
.
Optional operations are implemented to either do nothing, return a value
indicating it is unsupported or throw UnsupportedOperationException
.Constructor and Description |
---|
BaseKeyedObjectPool() |
Modifier and Type | Method and Description |
---|---|
void |
addObject(Object key)
Not supported in this base implementation.
|
abstract Object |
borrowObject(Object key)
Obtains an instance from this pool for the specified
key . |
void |
clear()
Not supported in this base implementation.
|
void |
clear(Object key)
Not supported in this base implementation.
|
void |
close()
Close this pool.
|
int |
getNumActive()
Not supported in this base implementation.
|
int |
getNumActive(Object key)
Not supported in this base implementation.
|
int |
getNumIdle()
Not supported in this base implementation.
|
int |
getNumIdle(Object key)
Not supported in this base implementation.
|
abstract void |
invalidateObject(Object key,
Object obj)
Invalidates an object from the pool.
|
abstract void |
returnObject(Object key,
Object obj)
Return an instance to the pool.
|
public void addObject(Object key) throws Exception, UnsupportedOperationException
UnsupportedOperationException
,
subclasses should override this behavior.addObject
in interface KeyedObjectPool
key
- ignoredUnsupportedOperationException
Exception
- when KeyedPoolableObjectFactory.makeObject(java.lang.Object)
fails.IllegalStateException
- after KeyedObjectPool.close()
has been called on this pool.public abstract Object borrowObject(Object 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
key
- the key used to obtain the objectIllegalStateException
- after close
has been called on this poolException
- when makeObject
throws an exceptionNoSuchElementException
- when the pool is exhausted and cannot or will not return another instancepublic void clear() throws Exception, UnsupportedOperationException
clear
in interface KeyedObjectPool
UnsupportedOperationException
Exception
public void clear(Object key) throws Exception, UnsupportedOperationException
clear
in interface KeyedObjectPool
key
- ignoredUnsupportedOperationException
Exception
public void close() throws Exception
isClosed
and assertOpen
.close
in interface KeyedObjectPool
Exception
public int getNumActive() throws UnsupportedOperationException
getNumActive
in interface KeyedObjectPool
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumActive(Object key) throws UnsupportedOperationException
getNumActive
in interface KeyedObjectPool
key
- ignoredUnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumIdle() throws UnsupportedOperationException
getNumIdle
in interface KeyedObjectPool
UnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic int getNumIdle(Object key) throws UnsupportedOperationException
getNumIdle
in interface KeyedObjectPool
key
- ignoredUnsupportedOperationException
- deprecated: when this implementation doesn't support the operationpublic abstract void invalidateObject(Object key, Object 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
key
- the key used to obtain the objectobj
- a borrowed
instance to be returned.Exception
public abstract void returnObject(Object key, Object 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
key
- the key used to obtain the objectobj
- a borrowed
instance to be returned.Exception
Copyright © 2001-2011 Apache Software Foundation. Documenation generated May 18 2012.