org.apache.commons.pool

Class BaseObjectPool

java.lang.Object

org.apache.commons.pool.BaseObjectPool

All Implemented Interfaces:

ObjectPool

Direct Known Subclasses:

GenericObjectPool, SoftReferenceObjectPool, StackObjectPool

public abstract class BaseObjectPool
extends java.lang.Object
implements ObjectPool

A simple base impementation of ObjectPool. All optional operations are implemented as throwing UnsupportedOperationException.

Version:

$Revision: 383290 $ $Date: 2006-03-05 02:00:15 -0500 (Sun, 05 Mar 2006) $

Author:

Rodney Waldhoff

Constructor Summary

Constructors

Constructor and Description
BaseObjectPool()

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseObjectPool

public BaseObjectPool()

Method Detail

addObject

public void addObject()
               throws java.lang.Exception,
                      java.lang.UnsupportedOperationException

Not supported in this base implementation.

Specified by:

addObject in interface ObjectPool

Throws:

java.lang.Exception

java.lang.UnsupportedOperationException

borrowObject

public abstract java.lang.Object borrowObject()
                                       throws java.lang.Exception

Description copied from interface: ObjectPool

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).

Specified by:

borrowObject in interface ObjectPool

Returns:

an instance from my pool.

Throws:

java.lang.Exception

clear

public void clear()
           throws java.lang.Exception,
                  java.lang.UnsupportedOperationException

Not supported in this base implementation.

Specified by:

clear in interface ObjectPool

Throws:

java.lang.UnsupportedOperationException - if this implementation does not support the operation

java.lang.Exception

close

public void close()
           throws java.lang.Exception

Description copied from interface: ObjectPool

Close this pool, and free any resources associated with it.

Specified by:

close in interface ObjectPool

Throws:

java.lang.Exception

getNumActive

public int getNumActive()
                 throws java.lang.UnsupportedOperationException

Not supported in this base implementation.

Specified by:

getNumActive in interface ObjectPool

Returns:

the number of instances currently borrowed in my pool

Throws:

java.lang.UnsupportedOperationException - if this implementation does not support the operation

getNumIdle

public int getNumIdle()
               throws java.lang.UnsupportedOperationException

Not supported in this base implementation.

Specified by:

getNumIdle in interface ObjectPool

Returns:

the number of instances currently idle in my pool

Throws:

java.lang.UnsupportedOperationException - if this implementation does not support the operation

invalidateObject

public abstract void invalidateObject(java.lang.Object obj)
                               throws java.lang.Exception

Description copied from interface: ObjectPool

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(java.lang.Object) method should be used instead.

Specified by:

invalidateObject in interface ObjectPool

Parameters:

obj - a borrowed instance to be returned.

Throws:

java.lang.Exception

returnObject

public abstract void returnObject(java.lang.Object obj)
                           throws java.lang.Exception

Description copied from interface: ObjectPool

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.

Specified by:

returnObject in interface ObjectPool

Parameters:

obj - a borrowed instance to be returned.

Throws:

java.lang.Exception

setFactory

public void setFactory(PoolableObjectFactory factory)
                throws java.lang.IllegalStateException,
                       java.lang.UnsupportedOperationException

Not supported in this base implementation.

Specified by:

setFactory in interface ObjectPool

Parameters:

factory - the PoolableObjectFactory I use to create new instances.

Throws:

java.lang.IllegalStateException - when the factory cannot be set at this time

java.lang.UnsupportedOperationException - if this implementation does not support the operation