|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.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. |
protected void |
assertOpen()
|
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.
|
protected boolean |
isClosed()
|
abstract void |
returnObject(Object obj)
Return an instance to my pool. |
void |
setFactory(org.apache.commons.pool.PoolableObjectFactory factory)
Not supported in this base implementation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BaseObjectPool()
Method Detail |
public abstract Object borrowObject() throws Exception
ObjectPool
returnObject
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 ObjectPool
Exception
public abstract void returnObject(Object obj) throws Exception
ObjectPool
borrowObject
or a related method as defined in an implementation
or sub-interface.
returnObject
in interface ObjectPool
obj
- a borrowed
instance to be returned.
Exception
public abstract void invalidateObject(Object obj) throws Exception
ObjectPool
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.
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 ObjectPool
obj
- a borrowed
instance to be returned.
Exception
public int getNumIdle() throws UnsupportedOperationException
getNumIdle
in interface ObjectPool
UnsupportedOperationException
- if this implementation does not support the operationpublic int getNumActive() throws UnsupportedOperationException
getNumActive
in interface ObjectPool
UnsupportedOperationException
- if this implementation does not support the operationpublic void clear() throws Exception, UnsupportedOperationException
clear
in interface ObjectPool
UnsupportedOperationException
- if this implementation does not support the operation
Exception
public void addObject() throws Exception, UnsupportedOperationException
addObject
in interface ObjectPool
Exception
UnsupportedOperationException
public void close() throws Exception
ObjectPool
close
in interface ObjectPool
Exception
public void setFactory(org.apache.commons.pool.PoolableObjectFactory factory) throws IllegalStateException, UnsupportedOperationException
setFactory
in interface ObjectPool
factory
- the PoolableObjectFactory
I use to create new instances.
UnsupportedOperationException
- if this implementation does not support the operation
IllegalStateException
- when the factory cannot be set at this timeprotected final boolean isClosed()
protected final void assertOpen() throws IllegalStateException
IllegalStateException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |