org.apache.commons.pool.impl
クラス StackObjectPool

java.lang.Object
  org.apache.commons.pool.BaseObjectPool
      org.apache.commons.pool.impl.StackObjectPool

すべての実装インタフェース:

ObjectPool

public class StackObjectPool

extends BaseObjectPool

implements ObjectPool

Stack をベースにしたシンプルな ObjectPool の実装です。

PoolableObjectFactory を渡されることにより、 このクラスはシンプルなインスタンスのプールを管理します。 "休止した"または未使用のインスタンスの数は制限されますが、 プールが空の場合には新たな取得要求にこたえるために新たなインスタンスが生成されます。 従ってこのクラスプールによって生成された"使用中"のインスタンスを数の制限なく持つことができますが、 不自然な制限をかけることなしに Object の再利用を行う際に非常に有用です。

バージョン:

$Revision: 1.1.1.1 $ $Date: 2004/02/13 10:02:01 $

作成者:

Rodney Waldhoff

翻訳者:

日置 聡

コンストラクタの概要

StackObjectPool()
ファクトリを使用せずに新たなプールを生成します。

StackObjectPool(int max)
ファクトリを使用せずに新たなプールを生成します。

StackObjectPool(int max, int init)
ファクトリを使用せずに新たなプールを生成します。

StackObjectPool(PoolableObjectFactory factory)
指定された factory を新規インスタンスの生成に使用する、新たな StackObjectPool を生成します。

StackObjectPool(PoolableObjectFactory factory, int max)
指定された factory を新規インスタンスの生成に使用し、 "休止した"インスタンスの数を max に制限する、新たな StackObjectPool を生成します。

StackObjectPool(PoolableObjectFactory factory, int max, int init)
指定された factory を新規インスタンスの生成に使用し、 "休止した"インスタンスの数を max に制限し、 初期化時に少なくとも init 個のインスタンスを格納できる容量を確保する、新たな StackObjectPool を生成します。

メソッドの概要

Object	borrowObject() プールからインスタンスを取り出します。
void	clear() プール内にある使用されていないオブジェクトを削除し、関連するリソースを開放します(オプショナルな処理)。
void	close() このプールを閉じ、関連する全てのリソースを開放します。
int	getNumActive() 現在プールから貸し出されているインスタンスの数を返します(オプショナルな処理)。
int	getNumIdle() 現在プール内にある使用されていないインスタンスの数を返します(オプショナルな処理)。
void	returnObject(Object obj) プールにインスタンスを返します。
void	setFactory(PoolableObjectFactory factory) 新たなインスタンスを生成するために使用する factory を設定します(オプショナルな処理)。

クラス java.lang.Object から継承したメソッド

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

コンストラクタの詳細

StackObjectPool

public StackObjectPool()

ファクトリを使用せずに新たなプールを生成します。 クライアントは 取得 を行う前にあらかじめ returnObject(java.lang.Object) を使ってプールにインスタンスを登録しておく必要があります。

StackObjectPool

public StackObjectPool(int max)

ファクトリを使用せずに新たなプールを生成します。 クライアントは 取得 を行う前にあらかじめ returnObject(java.lang.Object) を使ってプールにインスタンスを登録しておく必要があります。

StackObjectPool

public StackObjectPool(int max,
                       int init)

ファクトリを使用せずに新たなプールを生成します。 クライアントは 取得 を行う前にあらかじめ returnObject(java.lang.Object) を使ってプールにインスタンスを登録しておく必要があります。

StackObjectPool

public StackObjectPool(PoolableObjectFactory factory)

指定された factory を新規インスタンスの生成に使用する、新たな StackObjectPool を生成します。

パラメータ:

factory - プールで使用される PoolableObjectFactory

StackObjectPool

public StackObjectPool(PoolableObjectFactory factory,
                       int max)

指定された factory を新規インスタンスの生成に使用し、 "休止した"インスタンスの数を max に制限する、新たな StackObjectPool を生成します。

パラメータ:

factory - プールで使用される PoolableObjectFactory

max - プール内の"休止した"インスタンスの数の上限

StackObjectPool

public StackObjectPool(PoolableObjectFactory factory,
                       int max,
                       int init)

指定された factory を新規インスタンスの生成に使用し、 "休止した"インスタンスの数を max に制限し、 初期化時に少なくとも init 個のインスタンスを格納できる容量を確保する、新たな StackObjectPool を生成します。

パラメータ:

factory - プールで使用される PoolableObjectFactory

max - プール内の "休止した" インスタンスの数の上限

init - プールの初期サイズ (これは容量の大きさを指し、事前にプール内にインスタンスを生成するわけではありません)

メソッドの詳細

borrowObject

public Object borrowObject()
                    throws Exception

インタフェース ObjectPool の記述:

プールからインスタンスを取り出します。 プールからインスタンスを取得したクライアントは必ず returnObject または実装クラスやサブインターフェイスのそれと関連するメソッドを使用して インスタンスをプールに返さなくてはなりません。

プール内のインスタンスが空の場合のこのメソッドの振る舞いは明示されません (各実装クラスで明示されるでしょう)。

定義:

インタフェース ObjectPool 内の borrowObject

定義:

クラス BaseObjectPool 内の borrowObject

例外:

Exception

clear

public void clear()

インタフェース ObjectPool の記述:

プール内にある使用されていないオブジェクトを削除し、関連するリソースを開放します(オプショナルな処理)。

定義:

インタフェース ObjectPool 内の clear

オーバーライド:

クラス BaseObjectPool 内の clear

close

public void close()
           throws Exception

インタフェース ObjectPool の記述:

このプールを閉じ、関連する全てのリソースを開放します。

定義:

インタフェース ObjectPool 内の close

オーバーライド:

クラス BaseObjectPool 内の close

例外:

Exception

getNumActive

public int getNumActive()

インタフェース ObjectPool の記述:

現在プールから貸し出されているインスタンスの数を返します(オプショナルな処理)。

定義:

インタフェース ObjectPool 内の getNumActive

オーバーライド:

クラス BaseObjectPool 内の getNumActive

getNumIdle

public int getNumIdle()

インタフェース ObjectPool の記述:

現在プール内にある使用されていないインスタンスの数を返します(オプショナルな処理)。 これは新たなインスタンスを生成せずに 取得 することのできるオブジェクトの数を対象とします。

定義:

インタフェース ObjectPool 内の getNumIdle

オーバーライド:

クラス BaseObjectPool 内の getNumIdle

returnObject

public void returnObject(Object obj)
                  throws Exception

インタフェース ObjectPool の記述:

プールにインスタンスを返します。 プールに返される obj は必ず borrowObject または実装クラスやサブインターフェイスのそれと関連するメソッドを使用して 取得されたインスタンスでなくてはなりません。

定義:

インタフェース ObjectPool 内の returnObject

定義:

クラス BaseObjectPool 内の returnObject

例外:

Exception

setFactory

public void setFactory(PoolableObjectFactory factory)
                throws IllegalStateException

インタフェース ObjectPool の記述:

新たなインスタンスを生成するために使用する factory を設定します(オプショナルな処理)。

定義:

インタフェース ObjectPool 内の setFactory

オーバーライド:

クラス BaseObjectPool 内の setFactory

例外:

IllegalStateException