|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||
java.lang.Objectorg.apache.commons.pool.BaseObjectPool
org.apache.commons.pool.impl.StackObjectPool
public class StackObjectPool
A simple, Stack-based ObjectPool implementation.
Given a PoolableObjectFactory, this class will maintain
a simple pool of instances. A finite number of "sleeping"
or idle instances is enforced, but when the pool is
empty, new instances are created to support the new load.
Hence this class places no limit on the number of "active"
instances created by the pool, but is quite useful for
re-using Objects without introducing
artificial limits.
| Constructor Summary | |
|---|---|
StackObjectPool()
Create a new pool using no factory. |
|
StackObjectPool(int maxIdle)
Create a new pool using no factory. |
|
StackObjectPool(int maxIdle,
int initIdleCapacity)
Create a new pool using no factory. |
|
StackObjectPool(PoolableObjectFactory factory)
Create a new StackObjectPool using the specified factory to create new instances. |
|
StackObjectPool(PoolableObjectFactory factory,
int maxIdle)
Create a new SimpleObjectPool using the specified factory to create new instances, capping the number of "sleeping" instances to max. |
|
StackObjectPool(PoolableObjectFactory factory,
int maxIdle,
int initIdleCapacity)
Create a new SimpleObjectPool using the specified factory to create new instances, capping the number of "sleeping" instances to max, and initially allocating a container capable of containing at least init instances. |
|
| Method Summary | |
|---|---|
void |
addObject()
Create an object, and place it into the pool. |
java.lang.Object |
borrowObject()
Obtains an instance from the pool. |
void |
clear()
Clears any objects sitting idle in the pool. |
void |
close()
Close this pool, and free any resources associated with it. |
int |
getNumActive()
Return the number of instances currently borrowed from this pool. |
int |
getNumIdle()
Return the number of instances currently idle in this pool. |
void |
invalidateObject(java.lang.Object obj)
Invalidates an object from the pool. |
void |
returnObject(java.lang.Object obj)
Returns an instance to the pool. |
void |
setFactory(PoolableObjectFactory factory)
Sets the factory this pool uses
to create new instances. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public StackObjectPool()
set the factory
else this pool will not behave correctly.
Clients may first populate the pool
using returnObject(java.lang.Object)
before they can be borrowed but this useage is discouraged.
StackObjectPool(PoolableObjectFactory)public StackObjectPool(int maxIdle)
set the factory
else this pool will not behave correctly.
Clients may first populate the pool
using returnObject(java.lang.Object)
before they can be borrowed but this useage is discouraged.
maxIdle - cap on the number of "sleeping" instances in the poolStackObjectPool(PoolableObjectFactory, int)
public StackObjectPool(int maxIdle,
int initIdleCapacity)
set the factory
else this pool will not behave correctly.
Clients may first populate the pool
using returnObject(java.lang.Object)
before they can be borrowed but this useage is discouraged.
maxIdle - cap on the number of "sleeping" instances in the poolinitIdleCapacity - initial size of the pool (this specifies the size of the container,
it does not cause the pool to be pre-populated.)StackObjectPool(PoolableObjectFactory, int, int)public StackObjectPool(PoolableObjectFactory factory)
factory - the PoolableObjectFactory used to populate the pool
public StackObjectPool(PoolableObjectFactory factory,
int maxIdle)
factory - the PoolableObjectFactory used to populate the poolmaxIdle - cap on the number of "sleeping" instances in the pool
public StackObjectPool(PoolableObjectFactory factory,
int maxIdle,
int initIdleCapacity)
factory - the PoolableObjectFactory used to populate the poolmaxIdle - cap on the number of "sleeping" instances in the poolinitIdleCapacity - initial size of the pool (this specifies the size of the container,
it does not cause the pool to be pre-populated.)| Method Detail |
|---|
public void addObject()
throws java.lang.Exception
addObject in interface ObjectPooladdObject in class BaseObjectPooljava.lang.Exception - when the _factory has a problem creating an object.
public java.lang.Object borrowObject()
throws java.lang.Exception
BaseObjectPool
borrowObject in interface ObjectPoolborrowObject in class BaseObjectPooljava.lang.Exception - if an instance cannot be obtained from the poolpublic void clear()
clear in interface ObjectPoolclear in class BaseObjectPool
public void close()
throws java.lang.Exception
Calling addObject() or borrowObject() after invoking
this method on a pool will cause them to throw an
IllegalStateException.
close in interface ObjectPoolclose in class BaseObjectPooljava.lang.Exception - deprecated: implementations should silently fail if not all resources can be freed.public int getNumActive()
getNumActive in interface ObjectPoolgetNumActive in class BaseObjectPoolpublic int getNumIdle()
getNumIdle in interface ObjectPoolgetNumIdle in class BaseObjectPool
public void invalidateObject(java.lang.Object obj)
throws java.lang.Exception
BaseObjectPoolobj 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.
invalidateObject in interface ObjectPoolinvalidateObject in class BaseObjectPoolobj - a borrowed instance to be disposed.
java.lang.Exception
public void returnObject(java.lang.Object obj)
throws java.lang.Exception
BaseObjectPool
returnObject in interface ObjectPoolreturnObject in class BaseObjectPoolobj - instance to return to the pool
java.lang.Exception
public void setFactory(PoolableObjectFactory factory)
throws java.lang.IllegalStateException
factory this pool uses
to create new instances. Trying to change
the factory while there are borrowed objects will
throw an IllegalStateException.
setFactory in interface ObjectPoolsetFactory in class BaseObjectPoolfactory - the PoolableObjectFactory used to create new instances.
java.lang.IllegalStateException - when the factory cannot be set at this time
|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||