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 を投げるように実装されています。

A simple base impementation of {@link ObjectPool}. All optional operations are implemented as throwing {@link UnsupportedOperationException}.

バージョン:
$Revision: 1.1 $ $Date: 2004/02/22 11:58:26 $
作成者:
Rodney Waldhoff
翻訳者:
日置 聡
翻訳状況:
初稿(校正者募集中)
翻訳更新日:
2004/02/21

コンストラクタの概要
BaseKeyedObjectPool()
           
 
メソッドの概要
 void addObject(Object key)
          この基底実装ではサポートされません。
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 invalidateObject(Object key, Object obj)
          プール内で管理されるオブジェクトを無効にします。
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()
メソッドの詳細

addObject

public void addObject(Object key)
               throws Exception,
                      UnsupportedOperationException
この基底実装ではサポートされません。
Not supported in this base implementation.

定義:
インタフェース KeyedObjectPool 内の addObject
例外:
Exception
UnsupportedOperationException

borrowObject

public abstract 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
パラメータ:
key - オブジェクトを取得する際に使用するキー
the key used to obtain the object
戻り値:
プールから取得したインスタンス
an instance from my pool.
例外:
Exception

clear

public void clear()
           throws Exception,
                  UnsupportedOperationException
この基底実装ではサポートされません。
Not supported in this base implementation.

定義:
インタフェース KeyedObjectPool 内の clear
例外:
UnsupportedOperationException - この実装がこの処理をサポートしない場合
when this implementation doesn't support the operation
Exception

clear

public void clear(Object key)
           throws Exception,
                  UnsupportedOperationException
この基底実装ではサポートされません。
Not supported in this base implementation.

定義:
インタフェース KeyedObjectPool 内の clear
例外:
UnsupportedOperationException - この実装がこの処理をサポートしない場合
when this implementation doesn't support the operation
Exception

close

public void close()
           throws Exception
この基底実装では何も行いません。
Does nothing this base implementation.

定義:
インタフェース KeyedObjectPool 内の close
例外:
Exception

getNumActive

public int getNumActive()
                 throws UnsupportedOperationException
この基底実装ではサポートされません。
Not supported in this base implementation.

定義:
インタフェース KeyedObjectPool 内の getNumActive
戻り値:
現在プールから貸し出されているインスタンスの数
the total number of instances currently borrowed from my pool
例外:
UnsupportedOperationException - この実装がこの処理をサポートしない場合
when this implementation doesn't support the operation

getNumActive

public int getNumActive(Object key)
                 throws UnsupportedOperationException
この基底実装ではサポートされません。
Not supported in this base implementation.

定義:
インタフェース KeyedObjectPool 内の getNumActive
パラメータ:
key - 対象となるキー
the key
戻り値:
現在プールから貸し出されている指定された key に対応するインスタンスの数
the number of instances corresponding to the given key currently borrowed in my pool
例外:
UnsupportedOperationException - この実装がこの処理をサポートしない場合
when this implementation doesn't support the operation

getNumIdle

public int getNumIdle()
               throws UnsupportedOperationException
この基底実装ではサポートされません。
Not supported in this base implementation.

定義:
インタフェース KeyedObjectPool 内の getNumIdle
戻り値:
プール内にある使用されていないインスタンスの数
the total number of instances currently idle in my pool
例外:
UnsupportedOperationException - この実装がこの処理をサポートしない場合
when this implementation doesn't support the operation

getNumIdle

public int getNumIdle(Object key)
               throws UnsupportedOperationException
この基底実装ではサポートされません。
Not supported in this base implementation.

定義:
インタフェース KeyedObjectPool 内の getNumIdle
パラメータ:
key - 対象となるキー
the key
戻り値:
プール内にある使用されていない指定された key に対応するインスタンスの数
the number of instances corresponding to the given key currently idle in my pool
例外:
UnsupportedOperationException - この実装がこの処理をサポートしない場合
when this implementation doesn't support the operation

invalidateObject

public abstract void invalidateObject(Object key,
                                      Object obj)
                               throws Exception
インタフェース KeyedObjectPool の記述:
プール内で管理されるオブジェクトを無効にします。 対象となる objborrowObject か、実装クラスに定義された関連するメソッドか、 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
パラメータ:
obj - プールから取得 されたインスタンス
a {@link #borrowObject borrowed} instance to be returned.
例外:
Exception

returnObject

public abstract 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
パラメータ:
key - オブジェクトを取得する際に使用するキー
the key used to obtain the object
obj - プールに返す KeyedObjectPool.borrowObject(java.lang.Object) にて取得されたインスタンス
a {@link #borrowObject(java.lang.Object) borrowed} instance to be returned.
例外:
Exception

setFactory

public void setFactory(KeyedPoolableObjectFactory factory)
                throws IllegalStateException,
                       UnsupportedOperationException
この基底実装ではサポートされません。
Not supported in this base implementation.

定義:
インタフェース KeyedObjectPool 内の setFactory
パラメータ:
factory - 新たなインスタンスを生成するために使用する KeyedPoolableObjectFactory
the {@link KeyedPoolableObjectFactory} I use to create new instances.
例外:
UnsupportedOperationException - この実装がこの処理をサポートしない場合
when this implementation doesn't support the operation
IllegalStateException - ファクトリを設定できる状態でない場合
IllegalStateException when the factory cannot be set at this time


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