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) $
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Not supported in this base implementation.protected final void
Throws anIllegalStateException
when this pool has been closed.abstract T
Obtains an instance from the pool.void
clear()
Not supported in this base implementation.void
close()
Close this pool.int
Not supported in this base implementation.int
Not supported in this base implementation.abstract void
invalidateObject
(T obj) Invalidates an object from the pool.final boolean
isClosed()
Has this pool instance been closed.abstract void
returnObject
(T obj) Returns an instance to the pool.void
setFactory
(PoolableObjectFactory<T> factory) Deprecated.to be removed in pool 2.0
-
Field Details
-
closed
private volatile boolean closedWhether or not the pool is closed
-
-
Constructor Details
-
BaseObjectPool
public BaseObjectPool()
-
-
Method Details
-
borrowObject
Obtains an instance from the pool.- Specified by:
borrowObject
in 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:
returnObject
in interfaceObjectPool<T>
- Parameters:
obj
- instance to return to the pool- Throws:
Exception
-
invalidateObject
Invalidates an object from the pool.
By contract,
obj
must 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:
invalidateObject
in interfaceObjectPool<T>
- Parameters:
obj
- aborrowed
instance to be disposed.- Throws:
Exception
-
getNumIdle
Not supported in this base implementation.- Specified by:
getNumIdle
in interfaceObjectPool<T>
- Returns:
- a negative value.
- Throws:
UnsupportedOperationException
-
getNumActive
Not supported in this base implementation.- Specified by:
getNumActive
in interfaceObjectPool<T>
- Returns:
- a negative value.
- Throws:
UnsupportedOperationException
-
clear
Not supported in this base implementation.- Specified by:
clear
in interfaceObjectPool<T>
- Throws:
UnsupportedOperationException
Exception
-
addObject
Not supported in this base implementation. Always throws anUnsupportedOperationException
, subclasses should override this behavior.- Specified by:
addObject
in interfaceObjectPool<T>
- Throws:
UnsupportedOperationException
Exception
- whenPoolableObjectFactory.makeObject()
fails.IllegalStateException
- afterObjectPool.close()
has been called on this pool.
-
close
Close this pool. This affects the behavior ofisClosed
andassertOpen
.- Specified by:
close
in interfaceObjectPool<T>
- Throws:
Exception
- deprecated: implementations should silently fail if not all resources can be freed.
-
setFactory
@Deprecated public void setFactory(PoolableObjectFactory<T> factory) throws IllegalStateException, UnsupportedOperationException Deprecated.to be removed in pool 2.0Not supported in this base implementation. Always throws anUnsupportedOperationException
, subclasses should override this behavior.- Specified by:
setFactory
in interfaceObjectPool<T>
- Parameters:
factory
- the PoolableObjectFactory- Throws:
UnsupportedOperationException
IllegalStateException
-
isClosed
public final boolean isClosed()Has this pool instance been closed.- Returns:
true
when this pool has been closed.
-
assertOpen
Throws anIllegalStateException
when this pool has been closed.- Throws:
IllegalStateException
- when this pool has been closed.- See Also:
-