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

既知の実装クラスの一覧:
BaseObjectPool, GenericObjectPool, SoftReferenceObjectPool, StackObjectPool

public interface ObjectPool

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

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

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

 Object obj = null;

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

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

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

メソッドの概要
 void addObject()
          自身のファクトリまたは他の実装に依存する機能によってプール内にオブジェクトを配置します。
 Object borrowObject()
          プールからインスタンスを取り出します。
 void clear()
          プール内にある使用されていないオブジェクトを削除し、関連するリソースを開放します(オプショナルな処理)。
 void close()
          このプールを閉じ、関連する全てのリソースを開放します。
 int getNumActive()
          現在プールから貸し出されているインスタンスの数を返します(オプショナルな処理)。
 int getNumIdle()
          現在プール内にある使用されていないインスタンスの数を返します(オプショナルな処理)。
 void invalidateObject(Object obj)
          プール内で管理されるオブジェクトを無効にします。
 void returnObject(Object obj)
          プールにインスタンスを返します。
 void setFactory(PoolableObjectFactory factory)
          新たなインスタンスを生成するために使用する factory を設定します(オプショナルな処理)。
 

メソッドの詳細

addObject

public void addObject()
               throws Exception
自身のファクトリまたは他の実装に依存する機能によってプール内にオブジェクトを配置します。 addObject() は事前に準備されたオブジェクトをプール内に用意する際に有用です(オプショナルな処理)。

例外:
Exception

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 - この実装がこの処理をサポートしない場合

invalidateObject

public void invalidateObject(Object obj)
                      throws Exception
プール内で管理されるオブジェクトを無効にします。 対象となる objborrowObject か、実装クラスに定義された関連するメソッドか、 key を用いたサブインターフェイスの同等の機能を持つメソッドによって取得されたものでなくてはなりません。

このメソッドはプールから取得されたオブジェクトが(例外等で)無効であるとみなされた場合に使用するべきです。 オブジェクト取得の前、もしくは戻された後にオブジェクトの評価を行う場合には PoolableObjectFactory.validateObject(java.lang.Object) を使用して下さい。

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

returnObject

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

パラメータ:
obj - プールに返す borrowed にて取得されたインスタンス
例外:
Exception

setFactory

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

パラメータ:
factory - 新たなインスタンスを生成するために使用する PoolableObjectFactory
例外:
IllegalStateException - ファクトリを設定できる状態でない場合
UnsupportedOperationException - この実装がこの処理をサポートしない場合


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