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.5 $ $Date: 2002/05/01 06:02:34 $
Author:
Rodney Waldhoff

Constructor Summary
SoftReferenceObjectPool()
           
SoftReferenceObjectPool(PoolableObjectFactory factory)
           
SoftReferenceObjectPool(PoolableObjectFactory factory, int initSize)
           
 
Method Summary
 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 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 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SoftReferenceObjectPool

public SoftReferenceObjectPool()

SoftReferenceObjectPool

public SoftReferenceObjectPool(PoolableObjectFactory factory)

SoftReferenceObjectPool

public SoftReferenceObjectPool(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

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

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

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

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

setFactory

public void setFactory(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


Copyright © 2001-2002 Apache Software Foundation. Documenation generated February 22 2003.