org.apache.commons.pool.impl

Class SoftReferenceObjectPool

Implemented Interfaces:
ObjectPool

public class SoftReferenceObjectPool
extends BaseObjectPool
implements ObjectPool

A SoftReference based ObjectPool.
Version:
$Revision: 383290 $ $Date: 2006-03-05 02:00:15 -0500 (Sun, 05 Mar 2006) $
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()
void
clear()
void
close()
int
getNumActive()
int
getNumIdle()
Returns an approximation not less than the of the number of idle instances in the pool.
void
invalidateObject(Object obj)
void
returnObject(Object obj)
void
setFactory(PoolableObjectFactory factory)

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
Specified by:
borrowObject in interface ObjectPool
Overrides:
borrowObject in interface BaseObjectPool

clear

public void clear()
Specified by:
clear in interface ObjectPool
Overrides:
clear in interface BaseObjectPool

close

public void close()
            throws Exception
Specified by:
close in interface ObjectPool
Overrides:
close in interface BaseObjectPool

getNumActive

public int getNumActive()
Specified by:
getNumActive in interface ObjectPool
Overrides:
getNumActive in interface BaseObjectPool

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
Specified by:
invalidateObject in interface ObjectPool
Overrides:
invalidateObject in interface BaseObjectPool

returnObject

public void returnObject(Object obj)
            throws Exception
Specified by:
returnObject in interface ObjectPool
Overrides:
returnObject in interface BaseObjectPool

setFactory

public void setFactory(PoolableObjectFactory factory)
            throws IllegalStateException
Specified by:
setFactory in interface ObjectPool
Overrides:
setFactory in interface BaseObjectPool

Copyright © 2001-2003 Apache Software Foundation. Documenation generated April 6 2007.