org.apache.commons.pool.impl

Class StackObjectPool

public class StackObjectPool extends BaseObjectPool implements ObjectPool

A simple, java.util.Stack 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.

Version: $Revision: 383290 $ $Date: 2006-03-05 02:00:15 -0500 (Sun, 05 Mar 2006) $

Author: Rodney Waldhoff Dirk Verbeeck

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
voidaddObject()
Create an object, and place it into the pool. addObject() is useful for "pre-loading" a pool with idle objects.
ObjectborrowObject()
voidclear()
voidclose()
intgetNumActive()
intgetNumIdle()
voidinvalidateObject(Object obj)
voidreturnObject(Object obj)
voidsetFactory(PoolableObjectFactory factory)

Constructor Detail

StackObjectPool

public StackObjectPool()
Create a new pool using no factory. Clients must first populate the pool using StackObjectPool before they can be borrowed.

StackObjectPool

public StackObjectPool(int maxIdle)
Create a new pool using no factory. Clients must first populate the pool using StackObjectPool before they can be borrowed.

Parameters: maxIdle cap on the number of "sleeping" instances in the pool

StackObjectPool

public StackObjectPool(int maxIdle, int initIdleCapacity)
Create a new pool using no factory. Clients must first populate the pool using StackObjectPool before they can be borrowed.

Parameters: maxIdle cap on the number of "sleeping" instances in the pool initIdleCapacity initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)

StackObjectPool

public StackObjectPool(PoolableObjectFactory factory)
Create a new StackObjectPool using the specified factory to create new instances.

Parameters: factory the PoolableObjectFactory used to populate the pool

StackObjectPool

public 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.

Parameters: factory the PoolableObjectFactory used to populate the pool maxIdle cap on the number of "sleeping" instances in the pool

StackObjectPool

public 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.

Parameters: factory the PoolableObjectFactory used to populate the pool maxIdle cap on the number of "sleeping" instances in the pool initIdleCapacity initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)

Method Detail

addObject

public void addObject()
Create an object, and place it into the pool. addObject() is useful for "pre-loading" a pool with idle objects.

Throws: Exception when the _factory has a problem creating an object.

borrowObject

public Object borrowObject()

clear

public void clear()

close

public void close()

getNumActive

public int getNumActive()

getNumIdle

public int getNumIdle()

invalidateObject

public void invalidateObject(Object obj)

returnObject

public void returnObject(Object obj)

setFactory

public void setFactory(PoolableObjectFactory factory)
Copyright © 2001-2003 Apache Software Foundation. Documenation generated August 23 2012.