org.apache.commons.pool.impl
Class StackObjectPoolFactory

java.lang.Object
  org.apache.commons.pool.impl.StackObjectPoolFactory

All Implemented Interfaces:

ObjectPoolFactory

public class StackObjectPoolFactory
extends Object
implements ObjectPoolFactory

A factory for creating StackObjectPool instances.

Since:

Pool 1.0

Version:

$Revision: 960705 $ $Date: 2010-07-05 14:19:10 -0700 (Mon, 05 Jul 2010) $

Author:

Rodney Waldhoff

See Also:

StackObjectPool, StackKeyedObjectPoolFactory

Constructor Summary

StackObjectPoolFactory(PoolableObjectFactory factory)
Create a new StackObjectPoolFactory.

StackObjectPoolFactory(PoolableObjectFactory factory, int maxIdle)
Create a new StackObjectPoolFactory.

StackObjectPoolFactory(PoolableObjectFactory factory, int maxIdle, int initIdleCapacity)
Create a new StackObjectPoolFactory.

Method Summary

ObjectPool	createPool() Create a StackObjectPool.
PoolableObjectFactory	getFactory() Returns the factory used by created pools.
int	getInitCapacity() Returns the initial capacity of created pools.
int	getMaxSleeping() Returns the maxIdle setting for created pools.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StackObjectPoolFactory

public StackObjectPoolFactory(PoolableObjectFactory factory)

Create a new StackObjectPoolFactory.

Parameters:

factory - the PoolableObjectFactory used by created pools.

See Also:

StackObjectPool.StackObjectPool(PoolableObjectFactory)

StackObjectPoolFactory

public StackObjectPoolFactory(PoolableObjectFactory factory,
                              int maxIdle)

Create a new StackObjectPoolFactory.

Parameters:

factory - the PoolableObjectFactory used by created pools.

maxIdle - cap on the number of "sleeping" instances in the pool.

StackObjectPoolFactory

public StackObjectPoolFactory(PoolableObjectFactory factory,
                              int maxIdle,
                              int initIdleCapacity)

Create a new StackObjectPoolFactory.

Parameters:

factory - the PoolableObjectFactory used by created pools.

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

createPool

public ObjectPool createPool()

Create a StackObjectPool.

Specified by:

createPool in interface ObjectPoolFactory

Returns:

a new StackObjectPool with the configured factory, maxIdle and initial capacity settings

getFactory

public PoolableObjectFactory getFactory()

Returns the factory used by created pools.

Returns:

the PoolableObjectFactory used by created pools

Since:

1.5.5

getInitCapacity

public int getInitCapacity()

Returns the initial capacity of created pools.

Returns:

size of created containers (created pools are not pre-populated)

Since:

1.5.5

getMaxSleeping

public int getMaxSleeping()

Returns the maxIdle setting for created pools.

Returns:

the maximum number of idle instances in created pools

Since:

1.5.5