Class BaseObjectPool<T>
- Type Parameters:
T
- Type of element pooled in this pool.
- All Implemented Interfaces:
ObjectPool<T>
- Direct Known Subclasses:
SoftReferenceObjectPool
ObjectPool
.
Optional operations are implemented to either do nothing, return a value
indicating it is unsupported or throw UnsupportedOperationException
.
This class is intended to be thread-safe.
- Since:
- 2.0
- Version:
- $Revision: 1566605 $
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Not supported in this base implementation.abstract T
Obtains an instance from this pool.void
clear()
Not supported in this base implementation.void
close()
Close this pool, and free any resources associated with it.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) Return an instance to the pool.
-
Constructor Details
-
BaseObjectPool
public BaseObjectPool()
-
-
Method Details
-
borrowObject
Description copied from interface:ObjectPool
Obtains an instance from this pool.Instances returned from this method will have been either newly created with
PooledObjectFactory.makeObject()
or will be a previously idle object and have been activated withPooledObjectFactory.activateObject(org.apache.commons.pool2.PooledObject<T>)
and then validated withPooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject<T>)
.By contract, clients must return the borrowed instance using
ObjectPool.returnObject(T)
,ObjectPool.invalidateObject(T)
, 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 strictly specified (although it may be specified by implementations).
- Specified by:
borrowObject
in interfaceObjectPool<T>
- Returns:
- an instance from this pool.
- Throws:
Exception
- whenPooledObjectFactory.makeObject()
throws an exception.
-
returnObject
Description copied from interface:ObjectPool
Return an instance to the pool. By contract,obj
must have been obtained usingObjectPool.borrowObject()
or a related method as defined in an implementation or sub-interface.- Specified by:
returnObject
in interfaceObjectPool<T>
- Parameters:
obj
- aborrowed
instance to be returned.- Throws:
Exception
- if an instance cannot be returned to the pool
-
invalidateObject
Description copied from interface:ObjectPool
Invalidates an object from the pool.By contract,
obj
must have been obtained usingObjectPool.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.
- Specified by:
invalidateObject
in interfaceObjectPool<T>
- Parameters:
obj
- aborrowed
instance to be disposed.- Throws:
Exception
- if the instance cannot be invalidated
-
getNumIdle
public int getNumIdle()Not supported in this base implementation.- Specified by:
getNumIdle
in interfaceObjectPool<T>
- Returns:
- a negative value.
-
getNumActive
public int getNumActive()Not supported in this base implementation.- Specified by:
getNumActive
in interfaceObjectPool<T>
- Returns:
- a negative value.
-
clear
Not supported in this base implementation.- Specified by:
clear
in interfaceObjectPool<T>
- Throws:
UnsupportedOperationException
- if the pool does not implement this methodException
- if the pool cannot be cleared
-
addObject
Not supported in this base implementation. Subclasses should override this behavior.- Specified by:
addObject
in interfaceObjectPool<T>
- Throws:
UnsupportedOperationException
- if the pool does not implement this methodException
- whenPooledObjectFactory.makeObject()
fails.
-
close
public void close()Close this pool, and free any resources associated with it.Calling
ObjectPool.addObject()
orObjectPool.borrowObject()
after invoking this method on a pool will cause them to throw anIllegalStateException
.Implementations should silently fail if not all resources can be freed.
This affects the behavior of
isClosed
andassertOpen
.- Specified by:
close
in interfaceObjectPool<T>
-
isClosed
public final boolean isClosed()Has this pool instance been closed.- Returns:
true
when this pool has been closed.
-