org.seasar.mayaa.cycle.script
インタフェース ScriptEnvironment

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

ParameterAware, PositionAware, java.io.Serializable

public interface ScriptEnvironment

extends ParameterAware

スクリプトの実行環境。

フィールドの概要

インタフェース org.seasar.mayaa.ParameterAware から継承したフィールド

IS_SECURE_WEB

メソッドの概要

void	addAttributeScope(AttributeScope attrs) ユーザー定義スコープオブジェクトを追加する。
CompiledScript	compile(SourceDescriptor source, java.lang.String encoding) スクリプトソースファイルを読み込んでコンパイルする。
CompiledScript	compile(java.lang.String script, PositionAware position) 式文字列をコンパイルする。
java.lang.Object	convertFromScriptObject(java.lang.Object scriptObject) スクリプト内部表現オブジェクトから、Javaのオブジェクトに変換する。
java.lang.Object	convertFromScriptObject(java.lang.Object scriptObject, java.lang.Class expectedClass) スクリプト内部表現オブジェクトから、Javaのオブジェクトに変換する。
void	endScope() テンプレート描画時に、プロセッサのエンドイベントと同期するためのメソッド。
java.lang.String	getBlockSign() スクリプト文字列ブロックの開きクオートに前置される識別文字列の取得。
void	initScope() テンプレート描画時に、プロセッサのスタートイベントと同期するためのメソッド。
boolean	isEmpty(java.lang.Object scriptResult) スクリプトとして空と見なせることを判定する。
java.util.Iterator	iterateAttributeScope() ユーザー定義スコープオブジェクトをイテレートする。
void	startScope(java.util.Map variables) テンプレート描画時に、プロセッサのスタートイベントと同期するためのメソッド。

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

getParameter, iterateParameterNames, setParameter

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

getLineNumber, getSystemID, isOnTemplate, setLineNumber, setOnTemplate, setSystemID

メソッドの詳細

addAttributeScope

public void addAttributeScope(AttributeScope attrs)

ユーザー定義スコープオブジェクトを追加する。

パラメータ:

attrs - ユーザー定義スコープ。

iterateAttributeScope

public java.util.Iterator iterateAttributeScope()

ユーザー定義スコープオブジェクトをイテレートする。

戻り値:

スコープオブジェクト（AttributeScope）のイテレータ。

getBlockSign

public java.lang.String getBlockSign()

スクリプト文字列ブロックの開きクオートに前置される識別文字列の取得。

戻り値:

開きクオート前置文字列。

compile

public CompiledScript compile(java.lang.String script,
                              PositionAware position)

式文字列をコンパイルする。

パラメータ:

script - スクリプト。

position - スクリプトソースの位置情報。

戻り値:

コンパイル済みスクリプトオブジェクト。

compile

public CompiledScript compile(SourceDescriptor source,
                              java.lang.String encoding)

スクリプトソースファイルを読み込んでコンパイルする。

パラメータ:

source - スクリプトソースファイル。

encoding - スクリプトソースファイルのエンコーディング。

戻り値:

コンパイル済みスクリプトオブジェクト。

initScope

public void initScope()

テンプレート描画時に、プロセッサのスタートイベントと同期するためのメソッド。 カレントServiceCycleのページスコープを初期化する。

startScope

public void startScope(java.util.Map variables)

テンプレート描画時に、プロセッサのスタートイベントと同期するためのメソッド。 カレントServiceCycleのページスコープに、スクリプト変数をプッシュする。

パラメータ:

variables - カスタムスコープ変数。

endScope

public void endScope()

テンプレート描画時に、プロセッサのエンドイベントと同期するためのメソッド。 カレントServiceCycleのページスコープから、スクリプトのスコープオブジェクト をポップする。

convertFromScriptObject

public java.lang.Object convertFromScriptObject(java.lang.Object scriptObject)

スクリプト内部表現オブジェクトから、Javaのオブジェクトに変換する。

パラメータ:

scriptObject - スクリプト内部表現オブジェクト。

戻り値:

Javaのオブジェクト。

convertFromScriptObject

public java.lang.Object convertFromScriptObject(java.lang.Object scriptObject,
                                                java.lang.Class expectedClass)

スクリプト内部表現オブジェクトから、Javaのオブジェクトに変換する。

パラメータ:

scriptObject - スクリプト内部表現オブジェクト。

expectedClass - 変換後のクラス。

戻り値:

Javaのオブジェクト。

導入されたバージョン:

1.1.11

isEmpty

public boolean isEmpty(java.lang.Object scriptResult)

スクリプトとして空と見なせることを判定する。

パラメータ:

scriptResult - 判定するオブジェクト

戻り値:

空と見なせるなら