|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
java.lang.Objectorg.apache.commons.pool.BaseObjectPool
A simple base impementation of ObjectPool.
All optional operations are implemented as throwing
UnsupportedOperationException.
| Constructor Summary | |
BaseObjectPool()
|
|
| Method Summary | |
void |
addObject()
Not supported in this base implementation. |
abstract Object |
borrowObject()
Obtain an instance from my pool. |
void |
clear()
Not supported in this base implementation. |
void |
close()
Close this pool, and free any resources associated with it. |
int |
getNumActive()
Not supported in this base implementation. |
int |
getNumIdle()
Not supported in this base implementation. |
abstract void |
invalidateObject(Object 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. |
abstract void |
returnObject(Object obj)
Return an instance to my pool. |
void |
setFactory(PoolableObjectFactory factory)
Not supported in this base implementation. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public BaseObjectPool()
| Method Detail |
public void addObject()
throws Exception,
UnsupportedOperationException
addObject in interface ObjectPoolException
UnsupportedOperationException
public abstract Object borrowObject()
throws Exception
ObjectPoolreturnObject
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 specified (although it may be specified by implementations).
borrowObject in interface ObjectPoolException
public void clear()
throws Exception,
UnsupportedOperationException
clear in interface ObjectPoolUnsupportedOperationException - if this implementation does not support the operation
Exception
public void close()
throws Exception
ObjectPool
close in interface ObjectPoolException
public int getNumActive()
throws UnsupportedOperationException
getNumActive in interface ObjectPoolUnsupportedOperationException - if this implementation does not support the operation
public int getNumIdle()
throws UnsupportedOperationException
getNumIdle in interface ObjectPoolUnsupportedOperationException - if this implementation does not support the operation
public abstract void invalidateObject(Object obj)
throws Exception
ObjectPoolborrowObject
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.
If the connection should be validated before or after borrowing,
then the PoolableObjectFactory.validateObject(java.lang.Object) method should be
used instead.
invalidateObject in interface ObjectPoolobj - a borrowed instance to be returned.
Exception
public abstract void returnObject(Object obj)
throws Exception
ObjectPoolborrowObject
or a related method as defined in an implementation
or sub-interface.
returnObject in interface ObjectPoolobj - a borrowed instance to be returned.
Exception
public void setFactory(PoolableObjectFactory factory)
throws IllegalStateException,
UnsupportedOperationException
setFactory in interface ObjectPoolfactory - the PoolableObjectFactory I use to create new instances.
IllegalStateException - when the factory cannot be set at this time
UnsupportedOperationException - if this implementation does not support the operation
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||