org.apache.commons.pool.impl
Class SoftReferenceObjectPool
- ObjectPool
public class SoftReferenceObjectPool
Version:
- Rodney Waldhoff
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).
|
SoftReferenceObjectPool
public SoftReferenceObjectPool()
SoftReferenceObjectPool
public SoftReferenceObjectPool(PoolableObjectFactory factory,
int initSize)
throws 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.
- addObject in interface ObjectPool
- 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).
- borrowObject in interface ObjectPool
- borrowObject in interface BaseObjectPool
- an instance from my pool.
clear
public void clear()
Clears any objects sitting idle in the pool, releasing any
associated resources (optional operation).
- clear in interface ObjectPool
- clear in interface BaseObjectPool
close
public void close()
throws Exception
Close this pool, and free any resources associated with it.
- close in interface ObjectPool
- close in interface BaseObjectPool
getNumActive
public int getNumActive()
Return the number of instances
currently borrowed from my pool
(optional operation).
- getNumActive in interface ObjectPool
- getNumActive in interface BaseObjectPool
- 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.
- getNumIdle in interface ObjectPool
- 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.
- invalidateObject in interface ObjectPool
- invalidateObject in interface BaseObjectPool
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.
- returnObject in interface ObjectPool
- returnObject in interface BaseObjectPool
obj
- a borrowed
instance to be returned.
Copyright © 2001-2003 Apache Software Foundation. Documenation generated May 21 2005.