Package org.apache.commons.pool
Class BaseObjectPool<T>
java.lang.Object
org.apache.commons.pool.BaseObjectPool<T>
- Type Parameters:
T- the type of objects held in this pool
- All Implemented Interfaces:
ObjectPool<T>
- Direct Known Subclasses:
GenericObjectPool,SoftReferenceObjectPool,StackObjectPool
A simple base implementation of
ObjectPool.
Optional operations are implemented to either do nothing, return a value
indicating it is unsupported or throw UnsupportedOperationException.- Since:
- Pool 1.0
- Version:
- $Revision: 1222396 $ $Date: 2011-12-22 14:02:25 -0500 (Thu, 22 Dec 2011) $
- Author:
- Rodney Waldhoff, Sandy McArthur
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidNot supported in this base implementation.abstract TObtains an instance from the pool.voidclear()Not supported in this base implementation.voidclose()Close this pool.intNot supported in this base implementation.intNot supported in this base implementation.abstract voidinvalidateObject(T obj) Invalidates an object from the pool.final booleanisClosed()Has this pool instance been closed.abstract voidreturnObject(T obj) Returns an instance to the pool.
-
Constructor Details
-
BaseObjectPool
public BaseObjectPool()
-
-
Method Details
-
borrowObject
Obtains an instance from the pool.- Specified by:
borrowObjectin interfaceObjectPool<T>- Returns:
- an instance from the pool
- Throws:
Exception- if an instance cannot be obtained from the pool
-
returnObject
Returns an instance to the pool.- Specified by:
returnObjectin interfaceObjectPool<T>- Parameters:
obj- instance to return to the pool- Throws:
Exception
-
invalidateObject
Invalidates an object from the pool.
By contract,
objmust have been obtained usingborrowObject.This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid.
- Specified by:
invalidateObjectin interfaceObjectPool<T>- Parameters:
obj- aborrowedinstance to be disposed.- Throws:
Exception
-
getNumIdle
Not supported in this base implementation.- Specified by:
getNumIdlein interfaceObjectPool<T>- Returns:
- a negative value.
- Throws:
UnsupportedOperationException
-
getNumActive
Not supported in this base implementation.- Specified by:
getNumActivein interfaceObjectPool<T>- Returns:
- a negative value.
- Throws:
UnsupportedOperationException
-
clear
Not supported in this base implementation.- Specified by:
clearin interfaceObjectPool<T>- Throws:
UnsupportedOperationExceptionException
-
addObject
Not supported in this base implementation. Always throws anUnsupportedOperationException, subclasses should override this behavior.- Specified by:
addObjectin interfaceObjectPool<T>- Throws:
UnsupportedOperationExceptionException- whenPoolableObjectFactory.makeObject()fails.IllegalStateException- afterObjectPool.close()has been called on this pool.
-
close
Close this pool. This affects the behavior ofisClosedandassertOpen.- Specified by:
closein interfaceObjectPool<T>- Throws:
Exception- deprecated: implementations should silently fail if not all resources can be freed.
-
isClosed
public final boolean isClosed()Has this pool instance been closed.- Returns:
truewhen this pool has been closed.
-