|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.pool.BaseObjectPool
public abstract class BaseObjectPool
A simple base implementation of ObjectPool.
Optional operations are implemented to either do nothing, return a value
indicating it is unsupported or throw UnsupportedOperationException.
| Constructor Summary | |
|---|---|
BaseObjectPool()
|
|
| Method Summary | |
|---|---|
void |
addObject()
Not supported in this base implementation. |
protected void |
assertOpen()
Throws an IllegalStateException when this pool has been closed. |
abstract Object |
borrowObject()
Obtains an instance from the pool. |
void |
clear()
Not supported in this base implementation. |
void |
close()
Close this pool. |
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. |
boolean |
isClosed()
Has this pool instance been closed. |
abstract void |
returnObject(Object obj)
Returns an instance to the pool. |
void |
setFactory(PoolableObjectFactory 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 BaseObjectPool()
| Method Detail |
|---|
public abstract Object borrowObject()
throws Exception
borrowObject in interface ObjectPoolException - if an instance cannot be obtained from the pool
public abstract void returnObject(Object obj)
throws Exception
returnObject in interface ObjectPoolobj - instance to return to the pool
Exception
public abstract void invalidateObject(Object obj)
throws Exception
Invalidates an object from the pool.
By contract, obj must have been obtained
using borrowObject.
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 ObjectPoolobj - a borrowed instance to be disposed.
Exception
public int getNumIdle()
throws UnsupportedOperationException
getNumIdle in interface ObjectPoolUnsupportedOperationException
public int getNumActive()
throws UnsupportedOperationException
getNumActive in interface ObjectPoolUnsupportedOperationException
public void clear()
throws Exception,
UnsupportedOperationException
clear in interface ObjectPoolUnsupportedOperationException
Exception
public void addObject()
throws Exception,
UnsupportedOperationException
UnsupportedOperationException,
subclasses should override this behavior.
addObject in interface ObjectPoolUnsupportedOperationException
Exception - when PoolableObjectFactory.makeObject() fails.
IllegalStateException - after ObjectPool.close() has been called on this pool.
public void close()
throws Exception
isClosed and assertOpen.
close in interface ObjectPoolException - deprecated: implementations should silently fail if not all resources can be freed.
public void setFactory(PoolableObjectFactory factory)
throws IllegalStateException,
UnsupportedOperationException
UnsupportedOperationException,
subclasses should override this behavior.
setFactory in interface ObjectPoolfactory - the PoolableObjectFactory
UnsupportedOperationException
IllegalStateExceptionpublic 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 | |||||||||