|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.pool.BaseKeyedObjectPool
public abstract class BaseKeyedObjectPool
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(Object key)
Not supported in this base implementation. |
protected void |
assertOpen()
Throws an IllegalStateException when this pool has been closed. |
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. |
protected boolean |
isClosed()
Has this pool instance been closed. |
abstract void |
returnObject(Object key,
Object obj)
Return an instance to the pool. |
void |
setFactory(KeyedPoolableObjectFactory factory)
Deprecated. to be removed in pool 2.0 |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BaseKeyedObjectPool()
| Method Detail |
|---|
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 KeyedObjectPoolkey - 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 instance
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 KeyedObjectPoolkey - the key used to obtain the objectobj - a borrowed instance to be returned.
Exception
public 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 KeyedObjectPoolkey - the key used to obtain the objectobj - a borrowed instance to be returned.
Exception
public void addObject(Object key)
throws Exception,
UnsupportedOperationException
UnsupportedOperationException,
subclasses should override this behavior.
addObject in interface KeyedObjectPoolkey - ignored
UnsupportedOperationException
Exception - when KeyedPoolableObjectFactory.makeObject(java.lang.Object) fails.
IllegalStateException - after KeyedObjectPool.close() has been called on this pool.
public int getNumIdle(Object key)
throws UnsupportedOperationException
getNumIdle in interface KeyedObjectPoolkey - ignored
UnsupportedOperationException - deprecated: when this implementation doesn't support the operation
public int getNumActive(Object key)
throws UnsupportedOperationException
getNumActive in interface KeyedObjectPoolkey - ignored
UnsupportedOperationException - deprecated: when this implementation doesn't support the operation
public int getNumIdle()
throws UnsupportedOperationException
getNumIdle in interface KeyedObjectPoolUnsupportedOperationException - deprecated: when this implementation doesn't support the operation
public int getNumActive()
throws UnsupportedOperationException
getNumActive in interface KeyedObjectPoolUnsupportedOperationException - deprecated: when this implementation doesn't support the operation
public void clear()
throws Exception,
UnsupportedOperationException
clear in interface KeyedObjectPoolUnsupportedOperationException
Exception
public void clear(Object key)
throws Exception,
UnsupportedOperationException
clear in interface KeyedObjectPoolkey - ignored
UnsupportedOperationException
Exception
public void close()
throws Exception
isClosed and assertOpen.
close in interface KeyedObjectPoolException
public void setFactory(KeyedPoolableObjectFactory factory)
throws IllegalStateException,
UnsupportedOperationException
UnsupportedOperationException,
subclasses should override this behavior.
setFactory in interface KeyedObjectPoolfactory - the new KeyedPoolableObjectFactory
IllegalStateException - when the factory cannot be set at this time
UnsupportedOperationException - when this implementation doesn't support the operationprotected final boolean isClosed()
true when this pool has been closed.
protected final void assertOpen()
throws IllegalStateException
IllegalStateException when this pool has been closed.
IllegalStateException - when this pool has been closed.isClosed()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||