org.apache.commons.pool
クラス BaseObjectPool

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

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

ObjectPool

直系の既知のサブクラス:

GenericObjectPool, SoftReferenceObjectPool, StackObjectPool

public abstract class BaseObjectPool

extends Object

implements ObjectPool

シンプルな ObjectPool の基底となる実装です。 全てのオプショナルな処理は UnsupportedOperationException を投げるように実装されています。

バージョン:

$Revision: 1.1 $ $Date: 2004/02/22 11:58:26 $

作成者:

Rodney Waldhoff

翻訳者:

日置 聡

コンストラクタの概要

BaseObjectPool()

メソッドの概要

void	addObject() この基底実装ではサポートされません。
abstract Object	borrowObject() プールからインスタンスを取り出します。
void	clear() この基底実装ではサポートされません。
void	close() このプールを閉じ、関連する全てのリソースを開放します。
int	getNumActive() この基底実装ではサポートされません。
int	getNumIdle() この基底実装ではサポートされません。
abstract void	invalidateObject(Object obj) プール内で管理されるオブジェクトを無効にします。
abstract void	returnObject(Object obj) プールにインスタンスを返します。
void	setFactory(PoolableObjectFactory factory) この基底実装ではサポートされません。

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

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

コンストラクタの詳細

BaseObjectPool

public BaseObjectPool()

メソッドの詳細

addObject

public void addObject()
               throws Exception,
                      UnsupportedOperationException

この基底実装ではサポートされません。

定義:

インタフェース ObjectPool 内の addObject

例外:

Exception

UnsupportedOperationException

borrowObject

public abstract Object borrowObject()
                             throws Exception

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

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

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

定義:

インタフェース ObjectPool 内の borrowObject

戻り値:

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

例外:

Exception

clear

public void clear()
           throws Exception,
                  UnsupportedOperationException

この基底実装ではサポートされません。

定義:

インタフェース ObjectPool 内の clear

例外:

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

Exception

close

public void close()
           throws Exception

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

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

定義:

インタフェース ObjectPool 内の close

例外:

Exception

getNumActive

public int getNumActive()
                 throws UnsupportedOperationException

この基底実装ではサポートされません。

定義:

インタフェース ObjectPool 内の getNumActive

戻り値:

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

例外:

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

getNumIdle

public int getNumIdle()
               throws UnsupportedOperationException

この基底実装ではサポートされません。

定義:

インタフェース ObjectPool 内の getNumIdle

戻り値:

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

例外:

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

invalidateObject

public abstract void invalidateObject(Object obj)
                               throws Exception

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

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

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

定義:

インタフェース ObjectPool 内の invalidateObject

パラメータ:

obj - プールから取得 されたインスタンス

例外:

Exception

returnObject

public abstract void returnObject(Object obj)
                           throws Exception

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

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

定義:

インタフェース ObjectPool 内の returnObject

パラメータ:

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

例外:

Exception

setFactory

public void setFactory(PoolableObjectFactory factory)
                throws IllegalStateException,
                       UnsupportedOperationException

この基底実装ではサポートされません。

定義:

インタフェース ObjectPool 内の setFactory

パラメータ:

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

例外:

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

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