org.apache.commons.pool
クラス BaseKeyedObjectPool

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

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

KeyedObjectPool

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

GenericKeyedObjectPool, StackKeyedObjectPool

public abstract class BaseKeyedObjectPool

extends Object

implements KeyedObjectPool

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

バージョン:

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

作成者:

Rodney Waldhoff

翻訳者:

日置 聡

コンストラクタの概要

BaseKeyedObjectPool()

メソッドの概要

abstract Object	borrowObject(Object key) プールから指定された key に対応するインスタンスを取り出します。
void	clear() この基底実装ではサポートされません。
void	clear(Object key) この基底実装ではサポートされません。
void	close() この基底実装では何も行いません。
int	getNumActive() この基底実装ではサポートされません。
int	getNumActive(Object key) この基底実装ではサポートされません。
int	getNumIdle() この基底実装ではサポートされません。
int	getNumIdle(Object key) この基底実装ではサポートされません。
abstract void	returnObject(Object key, Object obj) プールにインスタンスを返します。
void	setFactory(KeyedPoolableObjectFactory factory) この基底実装ではサポートされません。

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

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

コンストラクタの詳細

BaseKeyedObjectPool

public BaseKeyedObjectPool()

メソッドの詳細

borrowObject

public abstract Object borrowObject(Object key)
                             throws Exception

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

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

定義:

インタフェース KeyedObjectPool 内の borrowObject

パラメータ:

key - オブジェクトを取得する際に使用するキー

戻り値:

プールから取得したインスタンス

例外:

Exception

clear

public void clear()
           throws Exception,
                  UnsupportedOperationException

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

定義:

インタフェース KeyedObjectPool 内の clear

例外:

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

Exception

clear

public void clear(Object key)
           throws Exception,
                  UnsupportedOperationException

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

定義:

インタフェース KeyedObjectPool 内の clear

パラメータ:

key - the key to clear

例外:

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

Exception

close

public void close()
           throws Exception

この基底実装では何も行いません。

定義:

インタフェース KeyedObjectPool 内の close

例外:

Exception

getNumActive

public int getNumActive()
                 throws UnsupportedOperationException

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

定義:

インタフェース KeyedObjectPool 内の getNumActive

戻り値:

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

例外:

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

getNumActive

public int getNumActive(Object key)
                 throws UnsupportedOperationException

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

定義:

インタフェース KeyedObjectPool 内の getNumActive

パラメータ:

key - 対象となるキー

戻り値:

現在プールから貸し出されている指定された key に対応するインスタンスの数

例外:

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

getNumIdle

public int getNumIdle()
               throws UnsupportedOperationException

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

定義:

インタフェース KeyedObjectPool 内の getNumIdle

戻り値:

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

例外:

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

getNumIdle

public int getNumIdle(Object key)
               throws UnsupportedOperationException

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

定義:

インタフェース KeyedObjectPool 内の getNumIdle

パラメータ:

key - 対象となるキー

戻り値:

プール内にある使用されていない指定された key に対応するインスタンスの数

例外:

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

returnObject

public abstract void returnObject(Object key,
                                  Object obj)
                           throws Exception

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

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

定義:

インタフェース KeyedObjectPool 内の returnObject

パラメータ:

key - オブジェクトを取得する際に使用するキー

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

例外:

Exception

setFactory

public void setFactory(KeyedPoolableObjectFactory factory)
                throws IllegalStateException,
                       UnsupportedOperationException

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

定義:

インタフェース KeyedObjectPool 内の setFactory

パラメータ:

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

例外:

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

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