public abstract class BaseObjectPool extends java.lang.Object implements ObjectPool
ObjectPool
.
All optional operations are implemented as throwing
UnsupportedOperationException
.Constructor and Description |
---|
BaseObjectPool() |
Modifier and Type | Method and Description |
---|---|
void |
addObject()
Not supported in this base implementation.
|
abstract java.lang.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(java.lang.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(java.lang.Object obj)
Return an instance to my pool.
|
void |
setFactory(PoolableObjectFactory factory)
Not supported in this base implementation.
|
public void addObject() throws java.lang.Exception, java.lang.UnsupportedOperationException
addObject
in interface ObjectPool
java.lang.Exception
java.lang.UnsupportedOperationException
public abstract java.lang.Object borrowObject() throws java.lang.Exception
ObjectPool
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
java.lang.Exception
public void clear() throws java.lang.Exception, java.lang.UnsupportedOperationException
clear
in interface ObjectPool
java.lang.UnsupportedOperationException
- if this implementation does not support the operationjava.lang.Exception
public void close() throws java.lang.Exception
ObjectPool
close
in interface ObjectPool
java.lang.Exception
public int getNumActive() throws java.lang.UnsupportedOperationException
getNumActive
in interface ObjectPool
java.lang.UnsupportedOperationException
- if this implementation does not support the operationpublic int getNumIdle() throws java.lang.UnsupportedOperationException
getNumIdle
in interface ObjectPool
java.lang.UnsupportedOperationException
- if this implementation does not support the operationpublic abstract void invalidateObject(java.lang.Object obj) throws java.lang.Exception
ObjectPool
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(java.lang.Object)
method should be
used instead.
invalidateObject
in interface ObjectPool
obj
- a borrowed
instance to be returned.java.lang.Exception
public abstract void returnObject(java.lang.Object obj) throws java.lang.Exception
ObjectPool
borrowObject
or a related method as defined in an implementation
or sub-interface.returnObject
in interface ObjectPool
obj
- a borrowed
instance to be returned.java.lang.Exception
public void setFactory(PoolableObjectFactory factory) throws java.lang.IllegalStateException, java.lang.UnsupportedOperationException
setFactory
in interface ObjectPool
factory
- the PoolableObjectFactory
I use to create new instances.java.lang.IllegalStateException
- when the factory cannot be set at this timejava.lang.UnsupportedOperationException
- if this implementation does not support the operationCopyright © 2001-2003 Apache Software Foundation. Documenation generated September 28 2013.