org.apache.commons.pool
インタフェース ObjectPool

既知の実装クラスの一覧:

BaseObjectPool, GenericObjectPool, SoftReferenceObjectPool, StackObjectPool

public interface ObjectPool

プーリングを行うためのためのインターフェイスです。

ObjectPool は一般的でシンプルなプーリングインターフェイスを定義します。 必須となるメソッドは borrowObject と returnObject だけです。

以下に使用方法を示します:

Object obj = null;

try {
obj = pool.borrowObject();
//...オブジェクトを使用...
} catch(Exception e) {
//...例外をハンドル...
} finally {
// 確実にオブジェクトをプールに返す
if(null != obj) {
pool.returnObject(obj);
}
}

シンプルな規定クラス BaseObjectPool を併せて参照ください。

バージョン:

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

作成者:

Rodney Waldhoff

翻訳者:

日置 聡

メソッドの概要

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

メソッドの詳細

borrowObject

public Object borrowObject()
                    throws Exception

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

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

戻り値:

プールから取り出されたインスタンス

例外:

Exception

clear

public void clear()
           throws Exception,
                  UnsupportedOperationException

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

例外:

UnsupportedOperationException - この実装がこの処理をサポートしない場合

Exception

close

public void close()
           throws Exception

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

例外:

Exception

getNumActive

public int getNumActive()
                 throws UnsupportedOperationException

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

戻り値:

現在プールから貸し出されているインスタンスの数

例外:

UnsupportedOperationException - この実装がこの処理をサポートしない場合

getNumIdle

public int getNumIdle()
               throws UnsupportedOperationException

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

戻り値:

プール内にある使用されていないインスタンスの数

例外:

UnsupportedOperationException - この実装がこの処理をサポートしない場合

returnObject

public void returnObject(Object obj)
                  throws Exception

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

パラメータ:

obj - プールに返す borrowObject() にて取得されたインスタンス

例外:

Exception

setFactory

public void setFactory(PoolableObjectFactory factory)
                throws IllegalStateException,
                       UnsupportedOperationException

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

パラメータ:

factory - 新たなインスタンスを生成するために使用する PoolableObjectFactory

例外:

IllegalStateException - ファクトリを設定できる状態でない場合

UnsupportedOperationException - この実装がこの処理をサポートしない場合