org.apache.commons.pool.impl

Class SoftReferenceObjectPool

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 $
Author:
Rodney Waldhoff

Constructor Summary

SoftReferenceObjectPool()
SoftReferenceObjectPool(PoolableObjectFactory factory)
SoftReferenceObjectPool(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(PoolableObjectFactory factory)
Sets the factory I use to create new instances (optional operation).

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

addObject, borrowObject, clear, close, getNumActive, getNumIdle, invalidateObject, returnObject, setFactory

Constructor Details

SoftReferenceObjectPool

public SoftReferenceObjectPool()

SoftReferenceObjectPool

public SoftReferenceObjectPool(PoolableObjectFactory factory)

SoftReferenceObjectPool

public SoftReferenceObjectPool(PoolableObjectFactory factory,
                               int initSize)
            throws Exception

Method Details

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 interface BaseObjectPool

borrowObject

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

Specified by:
borrowObject in interface ObjectPool
Overrides:
borrowObject in interface BaseObjectPool
Returns:
an instance from my pool.

clear

public void clear()
Clears any objects sitting idle in the pool, releasing any associated resources (optional operation).
Specified by:
clear in interface ObjectPool
Overrides:
clear in interface BaseObjectPool

close

public void close()
            throws Exception
Close this pool, and free any resources associated with it.
Specified by:
close in interface ObjectPool
Overrides:
close in interface BaseObjectPool

getNumActive

public int getNumActive()
Return the number of instances currently borrowed from my pool (optional operation).
Specified by:
getNumActive in interface ObjectPool
Overrides:
getNumActive in interface BaseObjectPool
Returns:
the number of instances currently borrowed in my pool

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 interface BaseObjectPool

invalidateObject

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

Specified by:
invalidateObject in interface ObjectPool
Overrides:
invalidateObject in interface BaseObjectPool
Parameters:
obj - a borrowed instance to be returned.

returnObject

public 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.
Specified by:
returnObject in interface ObjectPool
Overrides:
returnObject in interface BaseObjectPool
Parameters:
obj - a borrowed instance to be returned.

setFactory

public void setFactory(PoolableObjectFactory factory)
            throws IllegalStateException
Sets the factory I use to create new instances (optional operation).
Specified by:
setFactory in interface ObjectPool
Overrides:
setFactory in interface BaseObjectPool
Parameters:
factory - the PoolableObjectFactory I use to create new instances.

Copyright © 2001-2003 Apache Software Foundation. Documenation generated March 6 2006.