org.apache.commons.pool
Class BaseObjectPool
- ObjectPool
public abstract class BaseObjectPool
A simple base impementation of
ObjectPool
.
All optional operations are implemented as throwing
UnsupportedOperationException
.
$Revision: 383290 $ $Date: 2006-03-05 02:00:15 -0500 (Sun, 05 Mar 2006) $ void | addObject() - Not supported in this base implementation.
|
abstract Object | borrowObject() - Obtain an instance from my pool.
|
void | clear() - Not supported in this base implementation.
|
void | close() - Close this pool, and free any resources associated with it.
|
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
By contract, obj MUST have been obtained
using
borrowObject
or a related method as defined in an implementation
or sub-interface.
|
abstract void | returnObject(Object obj) - Return an instance to my pool.
|
void | setFactory(PoolableObjectFactory factory) - Not supported in this base implementation.
|
addObject
public void addObject()
throws Exception,
UnsupportedOperationException
Not supported in this base implementation.
- addObject in interface ObjectPool
borrowObject
public abstract Object borrowObject()
throws Exception
Obtain an instance from my pool.
By contract, clients MUST return
the borrowed instance using
returnObject
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 specified (although it may be specified by implementations).
- borrowObject in interface ObjectPool
- an instance from my pool.
clear
public void clear()
throws Exception,
UnsupportedOperationException
Not supported in this base implementation.
- clear in interface ObjectPool
close
public void close()
throws Exception
Close this pool, and free any resources associated with it.
- close in interface ObjectPool
getNumActive
public int getNumActive()
throws UnsupportedOperationException
Not supported in this base implementation.
- getNumActive in interface ObjectPool
getNumIdle
public int getNumIdle()
throws UnsupportedOperationException
Not supported in this base implementation.
- getNumIdle in interface ObjectPool
invalidateObject
public abstract void invalidateObject(Object obj)
throws Exception
Invalidates an object from the pool
By contract,
obj MUST have been obtained
using
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.
If the connection should be validated before or after borrowing,
then the
PoolableObjectFactory.validateObject(Object)
method should be
used instead.
- invalidateObject in interface ObjectPool
obj
- a borrowed
instance to be returned.
returnObject
public abstract void returnObject(Object obj)
throws Exception
Return an instance to my pool.
By contract,
obj MUST have been obtained
using
borrowObject
or a related method as defined in an implementation
or sub-interface.
- returnObject in interface ObjectPool
obj
- a borrowed
instance to be returned.
Copyright © 2001-2003 Apache Software Foundation. Documenation generated March 8 2007.