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

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

public interface PoolableObjectFactory

ObjectPool で使用されるインスタンスの ライフサイクルに関するメソッドを定義したインターフェイスです。

ObjectPool を生成する際に PoolableObjectFactory が指定され、以下の処理が行われます。

  1. 新たなインスタンスが必要となった場合 makeObject が呼ばれます。
  2. プールからインスタンスが渡される前には activateObject が実施されます。
  3. プールにインスタンスが戻されると passivateObject が実施されます。 pool.
  4. ( validateObject の結果またはプールの実装に指定された理由によって) プールからインスタンスが取り除かれる場合には destroyObject が実施されます。
  5. 各実装がプール内のインスタンスが有効な状態かどうか判断するための方法として validateObject が実施されます。 これは "activated" なインスタンスに対してのみ行われます。

バージョン:
$Revision: 1.1 $ $Date: 2004/02/22 11:58:26 $
作成者:
Rodney Waldhoff
関連項目:
ObjectPool
翻訳者:
日置 聡

メソッドの概要
 void activateObject(Object obj)
          プールから取り出されるインスタンスの初期化を行います。
 void destroyObject(Object obj)
          プールで必要のなくなったインスタンスを破棄します。
 Object makeObject()
          プールにて使用されるインスタンスを生成します。
 void passivateObject(Object obj)
          プールに戻されたインスタンスの後処理を行います。
 boolean validateObject(Object obj)
          このインスタンスがプールにて安全に使用できるかを判断します。
 

メソッドの詳細

activateObject

public void activateObject(Object obj)
                    throws Exception
プールから取り出されるインスタンスの初期化を行います。

パラメータ:
obj - プールから取り出されるインスタンス
例外:
Exception

destroyObject

public void destroyObject(Object obj)
                   throws Exception
プールで必要のなくなったインスタンスを破棄します。

パラメータ:
obj - 破棄されるインスタンス
例外:
Exception

makeObject

public Object makeObject()
                  throws Exception
プールにて使用されるインスタンスを生成します。

戻り値:
プールにて使用されるインスタンス
例外:
Exception

passivateObject

public void passivateObject(Object obj)
                     throws Exception
プールに戻されたインスタンスの後処理を行います。

パラメータ:
obj - プールに戻されたインスタンス
例外:
Exception

validateObject

public boolean validateObject(Object obj)
このインスタンスがプールにて安全に使用できるかを判断します。 このオブジェクトを破棄するべき場合には false を返します。

パラメータ:
obj - チェックを行うインスタンス
戻り値:
obj が無効でプールから削除すべき場合 false、 それ以外の場合 true


このドキュメントは、Ja-Jakartaにより訳されました。 コメントがある場合は report@jajakarta.orgまでお願いします。
Translated into Japanese by jajakarta.org. The original page is here.
Copyright (c) 2002-2003 - Apache Software Foundation