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
public abstract class BaseObjectPool<T> extends java.lang.Object implements ObjectPool<T>
A simple base implementation ofObjectPool. Optional operations are implemented to either do nothing, return a value indicating it is unsupported or throwUnsupportedOperationException.- 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 Constructor Description BaseObjectPool()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddObject()Not supported in this base implementation.abstract TborrowObject()Obtains an instance from the pool.voidclear()Not supported in this base implementation.voidclose()Close this pool.intgetNumActive()Not supported in this base implementation.intgetNumIdle()Not supported in this base implementation.abstract voidinvalidateObject(T obj)Invalidates an object from the pool.booleanisClosed()Has this pool instance been closed.abstract voidreturnObject(T obj)Returns an instance to the pool.
-
-
-
Method Detail
-
borrowObject
public abstract T borrowObject() throws java.lang.Exception
Obtains an instance from the pool.- Specified by:
borrowObjectin interfaceObjectPool<T>- Returns:
- an instance from the pool
- Throws:
java.lang.Exception- if an instance cannot be obtained from the pool
-
returnObject
public abstract void returnObject(T obj) throws java.lang.Exception
Returns an instance to the pool.- Specified by:
returnObjectin interfaceObjectPool<T>- Parameters:
obj- instance to return to the pool- Throws:
java.lang.Exception
-
invalidateObject
public abstract void invalidateObject(T obj) throws java.lang.Exception
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:
java.lang.Exception
-
getNumIdle
public int getNumIdle() throws java.lang.UnsupportedOperationExceptionNot supported in this base implementation.- Specified by:
getNumIdlein interfaceObjectPool<T>- Returns:
- a negative value.
- Throws:
java.lang.UnsupportedOperationException
-
getNumActive
public int getNumActive() throws java.lang.UnsupportedOperationExceptionNot supported in this base implementation.- Specified by:
getNumActivein interfaceObjectPool<T>- Returns:
- a negative value.
- Throws:
java.lang.UnsupportedOperationException
-
clear
public void clear() throws java.lang.Exception, java.lang.UnsupportedOperationExceptionNot supported in this base implementation.- Specified by:
clearin interfaceObjectPool<T>- Throws:
java.lang.UnsupportedOperationExceptionjava.lang.Exception
-
addObject
public void addObject() throws java.lang.Exception, java.lang.UnsupportedOperationExceptionNot supported in this base implementation. Always throws anUnsupportedOperationException, subclasses should override this behavior.- Specified by:
addObjectin interfaceObjectPool<T>- Throws:
java.lang.UnsupportedOperationExceptionjava.lang.Exception- whenPoolableObjectFactory.makeObject()fails.java.lang.IllegalStateException- afterObjectPool.close()has been called on this pool.
-
close
public void close() throws java.lang.ExceptionClose this pool. This affects the behavior ofisClosedandassertOpen.- Specified by:
closein interfaceObjectPool<T>- Throws:
java.lang.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.
-
-