org.seasar.mayaa.cycle.scope
インタフェース AttributeScope

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

ParameterAware, PositionAware, java.io.Serializable

既知のサブインタフェースの一覧:

ApplicationScope, RequestScope, SessionScope

public interface AttributeScope

extends ParameterAware

名前つきでオブジェクトを保存できる「スコープ」概念インターフェイス。

メソッドの概要

java.lang.Object	getAttribute(java.lang.String name) このスコープ中から指定された名前に対応したオブジェクトを返す。
java.lang.String	getScopeName() スコープ識別の取得を行う補助メソッド。
boolean	hasAttribute(java.lang.String name) このスコープ中に指定された名前に対応したオブジェクトがあるかをテストする。
boolean	isAttributeWritable() このスコープ中にオブジェクトの書き込みおよび削除ができるかを返す。
java.util.Iterator	iterateAttributeNames() このスコープに保存されている名前をイテレートする。
java.lang.Object	newAttribute(java.lang.String name, java.lang.Class attributeClass) このスコープ中に、指定クラス型のオブジェクトを生成する。
void	removeAttribute(java.lang.String name) このスコープ中の指定名オブジェクトを削除する。
void	setAttribute(java.lang.String name, java.lang.Object attribute) このスコープ中に、指定名でオブジェクトを保存する。

インタフェース org.seasar.mayaa.ParameterAware から継承したメソッド

getParameter, iterateParameterNames, setParameter

インタフェース org.seasar.mayaa.PositionAware から継承したメソッド

getLineNumber, getSystemID, isOnTemplate, setLineNumber, setOnTemplate, setSystemID

メソッドの詳細

getScopeName

public java.lang.String getScopeName()

スコープ識別の取得を行う補助メソッド。

戻り値:

スコープ識別。

iterateAttributeNames

public java.util.Iterator iterateAttributeNames()

このスコープに保存されている名前をイテレートする。

戻り値:

名前（String）の入ったイテレータ。

hasAttribute

public boolean hasAttribute(java.lang.String name)

このスコープ中に指定された名前に対応したオブジェクトがあるかをテストする。

パラメータ:

name - 指定オブジェクト名。

戻り値:

テスト結果。

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

このスコープ中から指定された名前に対応したオブジェクトを返す。 名前文字列がnullもしくは空白文字列、もしくは該当オブジェクトが無い場合には、 UNDEFINEDを返す。

パラメータ:

name - 指定オブジェクト名。

戻り値:

指定オブジェクト。

isAttributeWritable

public boolean isAttributeWritable()

このスコープ中にオブジェクトの書き込みおよび削除ができるかを返す。

戻り値:

テスト結果。

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object attribute)

このスコープ中に、指定名でオブジェクトを保存する。

パラメータ:

name - 指定名。nullおよび空白文字列だと何もしない。

attribute - 指定オブジェクト。

removeAttribute

public void removeAttribute(java.lang.String name)

このスコープ中の指定名オブジェクトを削除する。

パラメータ:

name - 指定名。nullおよび空白文字列だと何もしない。

newAttribute

public java.lang.Object newAttribute(java.lang.String name,
                                     java.lang.Class attributeClass)

このスコープ中に、指定クラス型のオブジェクトを生成する。 すでに同じ名前で違うクラス型のオブジェクトが存在する場合の処理や、 名前やクラス型の引数チェックの仕様は定めない。実装毎の仕様となる。

パラメータ:

name - 指定名。

attributeClass - 指定クラス型。

戻り値:

指定オブジェクト。