StackKeyedObjectPool (Jakarta Commons Object Pooling Package)

Overview

Package

Class

Index

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.pool.impl
Class StackKeyedObjectPool

java.lang.Object
  |
  +--org.apache.commons.pool.BaseKeyedObjectPool
        |
        +--org.apache.commons.pool.impl.StackKeyedObjectPool

All Implemented Interfaces:: KeyedObjectPool

public class StackKeyedObjectPool
extends BaseKeyedObjectPool
implements KeyedObjectPool

A simple, Stack-based KeyedObjectPool implementation.

Given a KeyedPoolableObjectFactory, this class will maintain a simple pool of instances. A finite number of "sleeping" or inactive 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:: $Id: StackKeyedObjectPool.java,v 1.5 2002/06/05 22:02:22 rwaldhoff Exp $
Author:: Rodney Waldhoff

Constructor Summary

StackKeyedObjectPool()
          Create a new pool using no factory.

StackKeyedObjectPool(int max)
          Create a new pool using no factory.

StackKeyedObjectPool(int max, int init)
          Create a new pool using no factory.

StackKeyedObjectPool(KeyedPoolableObjectFactory factory)
          Create a new SimpleKeyedObjectPool using the specified factory to create new instances.

StackKeyedObjectPool(KeyedPoolableObjectFactory factory, int max)
          Create a new SimpleKeyedObjectPool using the specified factory to create new instances.

StackKeyedObjectPool(KeyedPoolableObjectFactory factory, int max, int init)
          Create a new SimpleKeyedObjectPool using the specified factory to create new instances.

Method Summary

Object borrowObject(Object key)
          Obtain an instance from my pool for the specified key.

void clear()
          Clears my pool, removing all pooled instances (optional operation).

void clear(Object key)
          Clears the specified pool, removing all pooled instances corresponding to the given key (optional operation).

void close()
          Close this pool, and free any resources associated with it.

int getNumActive()
          Returns the total number of instances current borrowed from my pool but not yet returned (optional operation).

int getNumActive(Object key)
          Returns the number of instances currently borrowed from but not yet returned to my pool corresponding to the given key (optional operation).

int getNumIdle()
          Returns the total number of instances currently idle in my pool (optional operation).

int getNumIdle(Object key)
          Returns the number of instances corresponding to the given key currently idle in my pool (optional operation).

void returnObject(Object key, Object obj)
          Return an instance to my pool.

void setFactory(KeyedPoolableObjectFactory factory)
          Sets the factory I use to create new instances (optional operation).

String toString()


Methods inherited from class java.lang.Object

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

Constructor Detail

StackKeyedObjectPool

public StackKeyedObjectPool()

Create a new pool using no factory. Clients must first populate the pool using returnObject(java.lang.Object,java.lang.Object) before they can be borrowed.

StackKeyedObjectPool

public StackKeyedObjectPool(int max)

Create a new pool using no factory. Clients must first populate the pool using returnObject(java.lang.Object,java.lang.Object) before they can be borrowed.

StackKeyedObjectPool

public StackKeyedObjectPool(int max,
                            int init)

Create a new pool using no factory. Clients must first populate the pool using returnObject(java.lang.Object,java.lang.Object) before they can be borrowed.

StackKeyedObjectPool

public StackKeyedObjectPool(KeyedPoolableObjectFactory factory)

Create a new SimpleKeyedObjectPool using the specified factory to create new instances.
Parameters:: factory - the KeyedPoolableObjectFactory used to populate the pool

StackKeyedObjectPool

public StackKeyedObjectPool(KeyedPoolableObjectFactory factory,
                            int max)

Create a new SimpleKeyedObjectPool using the specified factory to create new instances. capping the number of "sleeping" instances to max
Parameters:: factory - the KeyedPoolableObjectFactory used to populate the pool; max - cap on the number of "sleeping" instances in the pool

StackKeyedObjectPool

public StackKeyedObjectPool(KeyedPoolableObjectFactory factory,
                            int max,
                            int init)

Create a new SimpleKeyedObjectPool 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 KeyedPoolableObjectFactory used to populate the pool; max - cap on the number of "sleeping" instances in the pool; init - initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)

Method Detail