org.apache.commons.pool.impl
Class SoftReferenceObjectPool

java.lang.Object
  |
  +--org.apache.commons.pool.BaseObjectPool
        |
        +--org.apache.commons.pool.impl.SoftReferenceObjectPool

All Implemented Interfaces:

ObjectPool

public class SoftReferenceObjectPool

extends BaseObjectPool

implements ObjectPool

A SoftReference based ObjectPool.

Version:

$Revision: 1.12 $ $Date: 2004/02/28 11:46:33 $

Constructor Summary

SoftReferenceObjectPool()

SoftReferenceObjectPool(org.apache.commons.pool.PoolableObjectFactory factory)

SoftReferenceObjectPool(org.apache.commons.pool.PoolableObjectFactory factory, int initSize)

Method Summary

void	addObject() Create an object, and place it into the pool.
Object	borrowObject() Obtain an instance from my pool.
void	clear() Clears any objects sitting idle in the pool, releasing any associated resources (optional operation).
void	close() Close this pool, and free any resources associated with it.
int	getNumActive() Return the number of instances currently borrowed from my pool (optional operation).
int	getNumIdle() Returns an approximation not less than the of the number of idle instances in the pool.
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.
void	returnObject(Object obj) Return an instance to my pool.
void	setFactory(org.apache.commons.pool.PoolableObjectFactory factory) Sets the factory I use to create new instances (optional operation).

Methods inherited from class org.apache.commons.pool.BaseObjectPool

assertOpen, isClosed

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftReferenceObjectPool

public SoftReferenceObjectPool()

SoftReferenceObjectPool

public SoftReferenceObjectPool(org.apache.commons.pool.PoolableObjectFactory factory)

SoftReferenceObjectPool

public SoftReferenceObjectPool(org.apache.commons.pool.PoolableObjectFactory factory,
                               int initSize)
                        throws Exception

Method Detail

borrowObject

public Object borrowObject()
                    throws 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

Specified by:

borrowObject in class BaseObjectPool

Returns:

an instance from my pool.

Exception

returnObject

public void returnObject(Object obj)
                  throws 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

Specified by:

returnObject in class BaseObjectPool

Parameters:

obj - a borrowed instance to be returned.

Exception

invalidateObject

public void invalidateObject(Object obj)
                      throws 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

Specified by:

invalidateObject in class BaseObjectPool

Parameters:

obj - a borrowed instance to be returned.

Exception

addObject

public void addObject()
               throws Exception

Create an object, and place it into the pool. addObject() is useful for "pre-loading" a pool with idle objects.

Specified by:

addObject in interface ObjectPool

Overrides:

addObject in class BaseObjectPool

Exception

getNumIdle

public int getNumIdle()

Returns an approximation not less than the of the number of idle instances in the pool.

Specified by:

getNumIdle in interface ObjectPool

Overrides:

getNumIdle in class BaseObjectPool

Returns:

the number of instances currently idle in my pool

getNumActive

public int getNumActive()

Description copied from interface: ObjectPool

Return the number of instances currently borrowed from my pool (optional operation).

Specified by:

getNumActive in interface ObjectPool

Overrides:

getNumActive in class BaseObjectPool

Returns:

the number of instances currently borrowed in my pool

clear

public void clear()

Description copied from interface: ObjectPool

Clears any objects sitting idle in the pool, releasing any associated resources (optional operation).

Specified by:

clear in interface ObjectPool

Overrides:

clear in class BaseObjectPool

close

public void close()
           throws Exception

Description copied from interface: ObjectPool

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

Specified by:

close in interface ObjectPool

Overrides:

close in class BaseObjectPool

Exception

setFactory

public void setFactory(org.apache.commons.pool.PoolableObjectFactory factory)
                throws IllegalStateException

Description copied from interface: ObjectPool

Sets the factory I use to create new instances (optional operation).

Specified by:

setFactory in interface ObjectPool

Overrides:

setFactory in class BaseObjectPool

Parameters:

factory - the PoolableObjectFactory I use to create new instances.

Throws:

IllegalStateException - when the factory cannot be set at this time