org.apache.commons.pool.impl
クラス StackKeyedObjectPool

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

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

KeyedObjectPool

public class StackKeyedObjectPool

extends BaseKeyedObjectPool

implements KeyedObjectPool

Stack をベースにしたシンプルな KeyedObjectPool の実装です。

A simple, {@link java.util.Stack Stack}-based {@link KeyedObjectPool} implementation.

PoolableObjectFactory を渡されることにより、 このクラスはシンプルなインスタンスのプールを管理します。 "休止した"または未使用のインスタンスの数は制限されますが、 プールが空の場合には新たな取得要求にこたえるために新たなインスタンスが生成されます。 従ってこのクラスプールによって生成された"使用中"のインスタンスを数の制限なく持つことができますが、 不自然な制限をかけることなしに Object の再利用を行う際に非常に有用です。

Given a {@link KeyedPoolableObjectFactory}, this class will maintain a simple pool of instances. A finite number of "sleeping" or inactive instances is enforced, but when the pool is empty, new instances are created to support the new load. Hence this class places no limit on the number of "active" instances created by the pool, but is quite useful for re-using Objects without introducing artificial limits.

バージョン:

$Id: StackKeyedObjectPool.java,v 1.1 2004/02/22 11:58:26 hioki Exp $

作成者:

Rodney Waldhoff

翻訳者:

日置 聡

翻訳状況:

初稿(校正者募集中)

翻訳更新日:

2004/02/21

コンストラクタの概要

StackKeyedObjectPool()
ファクトリを使用せずに新たなプールを生成します。

StackKeyedObjectPool(int max)
ファクトリを使用せずに新たなプールを生成します。

StackKeyedObjectPool(int max, int init)
ファクトリを使用せずに新たなプールを生成します。

StackKeyedObjectPool(KeyedPoolableObjectFactory factory)
指定された factory を新規インスタンスの生成に使用する、新たな StackKeyedObjectPool を生成します。

StackKeyedObjectPool(KeyedPoolableObjectFactory factory, int max)
指定された factory を新規インスタンスの生成に使用し、 "休止した状態の"インスタンスの数を max に制限する、新たな StackKeyedObjectPool を生成します。

StackKeyedObjectPool(KeyedPoolableObjectFactory factory, int max, int init)
指定された factory を新規インスタンスの生成に使用し、 "休止した状態の"インスタンスの数を max に制限し、 初期化時に少なくとも init 個のインスタンスを格納できる容量を確保する、新たな StackKeyedObjectPool を生成します。

メソッドの概要

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

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

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

コンストラクタの詳細

StackKeyedObjectPool

public StackKeyedObjectPool()

ファクトリを使用せずに新たなプールを生成します。 クライアントは 取得 を行う前にあらかじめ returnObject(java.lang.Object,java.lang.Object) を使ってプールにインスタンスを登録しておく必要があります。

Create a new pool using no factory. Clients must first populate the pool using {@link #returnObject(java.lang.Object,java.lang.Object)} before they can be {@link #borrowObject(java.lang.Object) borrowed}.

StackKeyedObjectPool

public StackKeyedObjectPool(int max)

ファクトリを使用せずに新たなプールを生成します。 クライアントは 取得 を行う前にあらかじめ returnObject(java.lang.Object,java.lang.Object) を使ってプールにインスタンスを登録しておく必要があります。

Create a new pool using no factory. Clients must first populate the pool using {@link #returnObject(java.lang.Object,java.lang.Object)} before they can be {@link #borrowObject(java.lang.Object) borrowed}.

パラメータ:

max - プール内の"休止した状態の"インスタンスの数の上限

cap on the number of "sleeping" instances in the pool

StackKeyedObjectPool

public StackKeyedObjectPool(int max,
                            int init)

ファクトリを使用せずに新たなプールを生成します。 クライアントは 取得 を行う前にあらかじめ returnObject(java.lang.Object,java.lang.Object) を使ってプールにインスタンスを登録しておく必要があります。

Create a new pool using no factory. Clients must first populate the pool using {@link #returnObject(java.lang.Object,java.lang.Object)} before they can be {@link #borrowObject(java.lang.Object) borrowed}.

パラメータ:

max - プール内の"休止した状態の"インスタンスの数の上限

cap on the number of "sleeping" instances in the pool

init - プールの初期サイズ (これは容量の大きさを指し、事前にプール内にインスタンスを生成するわけではありません)

initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)

StackKeyedObjectPool

public StackKeyedObjectPool(KeyedPoolableObjectFactory factory)

指定された factory を新規インスタンスの生成に使用する、新たな StackKeyedObjectPool を生成します。

Create a new SimpleKeyedObjectPool using the specified factory to create new instances.

パラメータ:

factory - プールで使用される KeyedPoolableObjectFactory

the {@link KeyedPoolableObjectFactory} used to populate the pool

StackKeyedObjectPool

public StackKeyedObjectPool(KeyedPoolableObjectFactory factory,
                            int max)

指定された factory を新規インスタンスの生成に使用し、 "休止した状態の"インスタンスの数を max に制限する、新たな StackKeyedObjectPool を生成します。

Create a new SimpleKeyedObjectPool using the specified factory to create new instances. capping the number of "sleeping" instances to max

パラメータ:

factory - プールで使用される KeyedPoolableObjectFactory

the {@link KeyedPoolableObjectFactory} used to populate the pool

max - プール内の"休止した状態の"インスタンスの数の上限

cap on the number of "sleeping" instances in the pool

StackKeyedObjectPool

public StackKeyedObjectPool(KeyedPoolableObjectFactory factory,
                            int max,
                            int init)

指定された factory を新規インスタンスの生成に使用し、 "休止した状態の"インスタンスの数を max に制限し、 初期化時に少なくとも init 個のインスタンスを格納できる容量を確保する、新たな StackKeyedObjectPool を生成します。

Create a new SimpleKeyedObjectPool using the specified factory to create new instances. capping the number of "sleeping" instances to max, and initially allocating a container capable of containing at least init instances.

パラメータ:

factory - プールで使用される KeyedPoolableObjectFactory

the {@link KeyedPoolableObjectFactory} used to populate the pool

max - プール内の"休止した状態の"インスタンスの数の上限

cap on the number of "sleeping" instances in the pool

init - プールの初期サイズ (これは容量の大きさを指し、事前にプール内にインスタンスを生成するわけではありません)

initial size of the pool (this specifies the size of the container, it does not cause the pool to be pre-populated.)

メソッドの詳細

addObject

public void addObject(Object key)
               throws Exception

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

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

Create an object using my {@link #setFactory factory} or other implementation dependent mechanism, and place it into the pool. addObject() is useful for "pre-loading" a pool with idle objects. (Optional operation).

定義:

インタフェース KeyedObjectPool 内の addObject

オーバーライド:

クラス BaseKeyedObjectPool 内の addObject

例外:

Exception

borrowObject

public Object borrowObject(Object key)
                    throws Exception

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

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

Obtain an instance from my pool for the specified key. By contract, clients MUST return the borrowed object using {@link #returnObject(java.lang.Object,java.lang.Object) returnObject}, or a related method as defined in an implementation or sub-interface, using a key that is equivalent to the one used to borrow the instance in the first place.

定義:

インタフェース KeyedObjectPool 内の borrowObject

定義:

クラス BaseKeyedObjectPool 内の borrowObject

例外:

Exception

clear

public void clear()

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

全てのプールされたすべてのインスタンスを削除し、プールをクリアします(オプショナルな処理)。 このプールが削除の機能を持たない場合 UnsupportedOperationException が投げられます。

Clears my pool, removing all pooled instances (optional operation). Throws {@link UnsupportedOperationException} if the pool cannot be cleared.

定義:

インタフェース KeyedObjectPool 内の clear

オーバーライド:

クラス BaseKeyedObjectPool 内の clear

clear

public void clear(Object key)

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

全てのプールされたインスタンスを削除し、プールをクリアします(オプショナルな処理)。 このプールが削除の機能を持たない場合 UnsupportedOperationException が投げられます。

Clears my pool, removing all pooled instances (optional operation). Throws {@link UnsupportedOperationException} if the pool cannot be cleared.

定義:

インタフェース KeyedObjectPool 内の clear

オーバーライド:

クラス BaseKeyedObjectPool 内の clear

close

public void close()
           throws Exception

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

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

Close this pool, and free any resources associated with it.

定義:

インタフェース KeyedObjectPool 内の close

オーバーライド:

クラス BaseKeyedObjectPool 内の close

例外:

Exception

getNumActive

public int getNumActive()

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

このプールから取得され、まだ戻されていないインスタンスの数を返します(オプショナルな処理)。 この情報を取得する機能を持たない場合 UnsupportedOperationException が投げられます。

Returns the total number of instances current borrowed from my pool but not yet returned (optional operation). Throws {@link UnsupportedOperationException} if this information is not available.

定義:

インタフェース KeyedObjectPool 内の getNumActive

オーバーライド:

クラス BaseKeyedObjectPool 内の getNumActive

getNumActive

public int getNumActive(Object key)

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

このプールから取得され、まだ戻されていない指定された key に対応するインスタンスの数を返します(オプショナルな処理)。 この情報を取得する機能を持たない場合 UnsupportedOperationException が投げられます。

Returns the number of instances currently borrowed from but not yet returned to my pool corresponding to the given key (optional operation). Throws {@link UnsupportedOperationException} if this information is not available.

定義:

インタフェース KeyedObjectPool 内の getNumActive

オーバーライド:

クラス BaseKeyedObjectPool 内の getNumActive

getNumIdle

public int getNumIdle()

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

現在プール内にある使用されていないインスタンスの数を返します(オプショナルな処理)。 この情報を取得する機能を持たない場合 UnsupportedOperationException が投げられます。

Returns the total number of instances currently idle in my pool (optional operation). Throws {@link UnsupportedOperationException} if this information is not available.

定義:

インタフェース KeyedObjectPool 内の getNumIdle

オーバーライド:

クラス BaseKeyedObjectPool 内の getNumIdle

getNumIdle

public int getNumIdle(Object key)

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

現在プール内にある使用されていない指定された key に対応するインスタンスの数を返します(オプショナルな処理)。 この情報を取得する機能を持たない場合 UnsupportedOperationException が投げられます。

Returns the number of instances corresponding to the given key currently idle in my pool (optional operation). Throws {@link UnsupportedOperationException} if this information is not available.

定義:

インタフェース KeyedObjectPool 内の getNumIdle

オーバーライド:

クラス BaseKeyedObjectPool 内の getNumIdle

invalidateObject

public void invalidateObject(Object key,
                             Object obj)
                      throws Exception

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

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

Invalidates an object from the pool By contract, obj MUST have been obtained using {@link #borrowObject borrowObject} or a related method as defined in an implementation or sub-interface using a key that is equivalent to the one used to borrow the Object in the first place.

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

This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid. If the connection should be validated before or after borrowing, then the {@link PoolableObjectFactory#validateObject} method should be used instead.

定義:

インタフェース KeyedObjectPool 内の invalidateObject

定義:

クラス BaseKeyedObjectPool 内の invalidateObject

例外:

Exception

returnObject

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

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

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

Return an instance to my pool. By contract, obj MUST have been obtained using {@link #borrowObject(java.lang.Object) borrowObject} or a related method as defined in an implementation or sub-interface using a key that is equivalent to the one used to borrow the Object in the first place.

定義:

インタフェース KeyedObjectPool 内の returnObject

定義:

クラス BaseKeyedObjectPool 内の returnObject

例外:

Exception

setFactory

public void setFactory(KeyedPoolableObjectFactory factory)
                throws IllegalStateException

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

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

Sets the {@link KeyedPoolableObjectFactory factory} I use to create new instances (optional operation).

定義:

インタフェース KeyedObjectPool 内の setFactory

オーバーライド:

クラス BaseKeyedObjectPool 内の setFactory

例外:

IllegalStateException

toString

public String toString()