|
||||||
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()
Obtain an instance from my pool. |
void |
clear()
Not supported in this base implementation. |
void |
close()
Close this pool, and free any resources associated with it. |
int |
getNumActive()
Not supported in this base implementation. |
int |
getNumIdle()
Not supported in this base implementation. |
void |
invalidateObject(java.lang.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(java.lang.Object obj)
Return an instance to my pool. |
void |
setFactory(PoolableObjectFactory factory)
Not supported in this base implementation. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StackObjectPool()
returnObject(java.lang.Object)
before they can be borrowed
.
public StackObjectPool(int maxIdle)
returnObject(java.lang.Object)
before they can be borrowed
.
maxIdle
- cap on the number of "sleeping" instances in the poolpublic StackObjectPool(int maxIdle, int initIdleCapacity)
returnObject(java.lang.Object)
before they can be borrowed
.
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.)public StackObjectPool(PoolableObjectFactory factory)
factory
- the PoolableObjectFactory
used to populate the poolpublic StackObjectPool(PoolableObjectFactory factory, int maxIdle)
factory
- the PoolableObjectFactory
used to populate the poolmaxIdle
- cap on the number of "sleeping" instances in the poolpublic 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 ObjectPool
addObject
in class BaseObjectPool
java.lang.Exception
- when the _factory
has a problem creating an object.public java.lang.Object borrowObject() throws java.lang.Exception
ObjectPool
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 class BaseObjectPool
java.lang.Exception
public void clear()
BaseObjectPool
clear
in interface ObjectPool
clear
in class BaseObjectPool
public void close() throws java.lang.Exception
ObjectPool
close
in interface ObjectPool
close
in class BaseObjectPool
java.lang.Exception
public int getNumActive()
BaseObjectPool
getNumActive
in interface ObjectPool
getNumActive
in class BaseObjectPool
public int getNumIdle()
BaseObjectPool
getNumIdle
in interface ObjectPool
getNumIdle
in class BaseObjectPool
public void invalidateObject(java.lang.Object obj) throws java.lang.Exception
ObjectPool
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(java.lang.Object)
method should be
used instead.
invalidateObject
in interface ObjectPool
invalidateObject
in class BaseObjectPool
obj
- a borrowed
instance to be returned.
java.lang.Exception
public void returnObject(java.lang.Object obj) throws java.lang.Exception
ObjectPool
borrowObject
or a related method as defined in an implementation
or sub-interface.
returnObject
in interface ObjectPool
returnObject
in class BaseObjectPool
obj
- a borrowed
instance to be returned.
java.lang.Exception
public void setFactory(PoolableObjectFactory factory) throws java.lang.IllegalStateException
BaseObjectPool
setFactory
in interface ObjectPool
setFactory
in class BaseObjectPool
factory
- the PoolableObjectFactory
I use 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 |