jp.livewell.baby.pool
クラス AbstractWrapper

java.lang.Object
  |
  +--jp.livewell.baby.pool.AbstractWrapper
すべての実装インタフェース:
Wrapper

public abstract class AbstractWrapper
extends java.lang.Object
implements Wrapper

Wrapperの動作の基礎的な部分を実装した抽象classです。

作成者:
mitsuhito

コンストラクタの概要
AbstractWrapper()
          AbstractWrapperを構築します。
 
メソッドの概要
 boolean activate(ComparisonKey key)
          このWrapperを有効化するときにPoolから呼び出されます。
 void destroy(ComparisonKey key)
          このWrapperを使用不可にし、確保しているリソースを直ちに開放し、 isWorkableをfalseに設定します。
protected  void finalize()
          java.lang.Objectのfinalizeをオーバーライドします。
protected  ComparisonKey getComparisonKey()
          このWapper instanceの戻り先Poolが保有する確認用keyを取得します。
protected  PoolReference getPoolReference()
          このWapper instanceの戻り先Poolへの参照を取得します。
 void init(PoolReference poolRef, ComparisonKey key)
          戻り先のPoolと比較用のkeyを与えてWrapperを初期化します。
protected  boolean isActivated()
          このWrapperが有効化されているかどうかを戻します。
protected  boolean isDestroyed()
          このWrapperが使用不可にされているかどうかを戻します。
protected  boolean isInitialized()
          このWrapperが初期化されているかどうかを戻します。
 boolean isWorkable()
          このWrapperが使用可能かどうかを戻します。
 boolean passivate(ComparisonKey key)
          このWrapperを無効化するときにPoolから呼び出されます。
protected abstract  boolean ping()
          内包するObjectの正当性確認に使用します。
 void release()
          このinstanceをPoolへ戻します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

AbstractWrapper

public AbstractWrapper()
AbstractWrapperを構築します。
メソッドの詳細

init

public void init(PoolReference poolRef,
                 ComparisonKey key)
          throws java.lang.IllegalStateException
戻り先のPoolと比較用のkeyを与えてWrapperを初期化します。1度初期化さ れたWrapperは2度目の初期化を行なうとIllegalStateExceptionをthrowします
定義:
インタフェース Wrapper 内の init
パラメータ:
ref - 戻り先Poolへの参照
key - 戻り先Poolの保有する比較用key
例外:
java.lang.IllegalStateException - 既に初期化されている場合

isWorkable

public boolean isWorkable()
このWrapperが使用可能かどうかを戻します。destroyが呼び出されていない 状態で、activateされているならtrueです。
定義:
インタフェース Wrapper 内の isWorkable
戻り値:
使用可能ならばtrue

activate

public boolean activate(ComparisonKey key)
                 throws java.lang.IllegalStateException,
                        java.lang.IllegalArgumentException
このWrapperを有効化するときにPoolから呼び出されます。成功すればtrue、 既に有効化されている場合はfalseが戻されます。内包するObjectが不正な (使用できない)場合はIllegalStateExceptionが、、keyが一致しない場合は IllegalArgumentExceptionがthrowされます。このメソッドはpingを呼び出 します。
定義:
インタフェース Wrapper 内の activate
パラメータ:
key - このWrapperを初期化したPoolの保有するComparisonKey
戻り値:
成功すればtrue、既に有効化されている場合はfalse。
例外:
java.lang.IllegalStateException - 内包するObjectが不正な(使用できない)場合
java.lang.IllegalArgumentException - keyが一致しない場合

ping

protected abstract boolean ping()
内包するObjectの正当性確認に使用します。 各sub classで適切な内容を記述して下さい。
戻り値:
内容が適切ならばtrue

passivate

public boolean passivate(ComparisonKey key)
                  throws java.lang.IllegalStateException,
                         java.lang.IllegalArgumentException
このWrapperを無効化するときにPoolから呼び出されます。成功すればtrue、 既に無効化されている場合はfalseが戻されます。keyが一致しない場合は IllegalArgumentExceptionがthrowされます。
定義:
インタフェース Wrapper 内の passivate
パラメータ:
key - このWrapperを初期化したPoolの保有するComparisonKey
戻り値:
成功すればtrue、既に無効化されている場合はfalse。
例外:
java.lang.IllegalStateException - 復旧できない理由で無効化出来ない場合
java.lang.IllegalArgumentException - keyが一致しない場合

release

public void release()
このinstanceをPoolへ戻します。
定義:
インタフェース Wrapper 内の release

destroy

public void destroy(ComparisonKey key)
             throws java.lang.IllegalArgumentException
このWrapperを使用不可にし、確保しているリソースを直ちに開放し、 isWorkableをfalseに設定します。通常このメソッドはPoolから呼ばれます。 destroyを呼び出された後のWrapperの動作は保証されません。 keyが一致しない場合はIllegalArgumentExceptionがthrowされます。
定義:
インタフェース Wrapper 内の destroy
パラメータ:
key - このWrapperを初期化したPoolの保有するComparisonKey
例外:
java.lang.IllegalArgumentException - keyが一致しない場合

finalize

protected void finalize()
                 throws java.lang.Throwable
java.lang.Objectのfinalizeをオーバーライドします。このWrapperがプー ルへ戻されずにその参照を他のインスタンスからたどれなくなった場合の処 理を記述します。
オーバーライド:
クラス java.lang.Object 内の finalize
例外:
java.lang.Throwable - このメソッドで処理できなかったExceptionやError

isInitialized

protected boolean isInitialized()
このWrapperが初期化されているかどうかを戻します。
戻り値:
初期化されていればtrue

isActivated

protected boolean isActivated()
このWrapperが有効化されているかどうかを戻します。
戻り値:
有効化されていればtrue

isDestroyed

protected boolean isDestroyed()
このWrapperが使用不可にされているかどうかを戻します。
戻り値:
使用不可にされていればtrue

getPoolReference

protected PoolReference getPoolReference()
このWapper instanceの戻り先Poolへの参照を取得します。
戻り値:
このWapper instanceの戻り先Poolへの参照

getComparisonKey

protected ComparisonKey getComparisonKey()
このWapper instanceの戻り先Poolが保有する確認用keyを取得します。
戻り値:
このWapper instanceの戻り先Poolが保有する確認用key