javax.script
インタフェース ScriptContext

既知の実装クラスの一覧:

SimpleScriptContext

public interface ScriptContext

このインタフェースを実装するクラスは、アプリケーションでスクリプトエンジンと、スコープ設定された Bindings などのオブジェクトとを接続するために使用されます。各スコープは、ScriptContext メソッドを使用して設定および取得可能な値を持つ名前付き属性のセットです。また、ScriptContext は、ScriptEngine が入力と出力に使用可能な Reader と Writer を公開します。

導入されたバージョン:

1.6

フィールドの概要

static int	ENGINE_SCOPE EngineScope 属性は、単一の ScriptEngine の寿命において可視です。
static int	GLOBAL_SCOPE GlobalScope 属性は、同じ ScriptEngineFactory によって作成されたすべてのエンジンに対して可視です。

メソッドの概要

Object	getAttribute(String name) スコープ内で、指定された名前を持つ属性の値を検索し、最初に見つかったものを取得します。
Object	getAttribute(String name, int scope) 指定されたスコープ内の属性の値を取得します。
int	getAttributesScope(String name) 属性が定義されている最小のスコープを取得します。
Bindings	getBindings(int scope) この ScriptContext 内の指定されたスコープに関連付けられた Bindings を取得します。
Writer	getErrorWriter() エラー出力を表示するときに使用する Writer を返します。
Reader	getReader() 入力を読み込むためにスクリプトが使用する Reader を返します。
List<Integer>	getScopes() ScriptContext 内のスコープに対する、すべての有効値の不変の List を返します。
Writer	getWriter() 出力を表示するときに使用するスクリプトの Writer を返します。
Object	removeAttribute(String name, int scope) 指定されたスコープ内の属性を削除します。
void	setAttribute(String name, Object value, int scope) 指定されたスコープ内の属性の値を設定します。
void	setBindings(Bindings bindings, int scope) Bindings インスタンスを、この ScriptContext 内の特定のスコープに関連付けます。
void	setErrorWriter(Writer writer) エラー出力を表示するときに使用する Writer を設定します。
void	setReader(Reader reader) 入力を読み込むためのスクリプトの Reader を設定します。
void	setWriter(Writer writer) 出力を表示するときに使用するスクリプトの Writer を設定します。

フィールドの詳細

ENGINE_SCOPE

static final int ENGINE_SCOPE

EngineScope 属性は、単一の ScriptEngine の寿命において可視です。また、属性のセットはエンジンごとに保持されます。

関連項目:

定数フィールド値

GLOBAL_SCOPE

static final int GLOBAL_SCOPE

GlobalScope 属性は、同じ ScriptEngineFactory によって作成されたすべてのエンジンに対して可視です。

関連項目:

定数フィールド値

メソッドの詳細

setBindings

void setBindings(Bindings bindings,
                 int scope)

Bindings インスタンスを、この ScriptContext 内の特定のスコープに関連付けます。getAttribute および setAttribute メソッドの呼び出しでは、特定のスコープに関する Bindings の get および put メソッドをマッピングする必要があります。

パラメータ:

bindings - 指定されたスコープに関連付けられる Bindings

scope - スコープ

例外:

IllegalArgumentException - この型の ScriptContext 内で指定されたスコープ値に対して Bindings が定義されていない場合。

NullPointerException - スコープの値が ENGINE_SCOPE で、指定された Bindings が null の場合。

getBindings

Bindings getBindings(int scope)

この ScriptContext 内の指定されたスコープに関連付けられた Bindings を取得します。

戻り値:

関連付けられている Bindings。設定されていない場合は null。

例外:

IllegalArgumentException - この型の ScriptContext 内で指定されたスコープ値に対して Bindings が定義されていない場合。

setAttribute

void setAttribute(String name,
                  Object value,
                  int scope)

指定されたスコープ内の属性の値を設定します。

パラメータ:

name - 設定する属性の名前

value - 属性の値

scope - 属性を設定するスコープ

例外:

IllegalArgumentException - name が空の場合、またはスコープが無効の場合。

NullPointerException - 名前が null の場合

getAttribute

Object getAttribute(String name,
                    int scope)

指定されたスコープ内の属性の値を取得します。

パラメータ:

name - 取得する属性の名前。

scope - 属性を取得するスコープ。

戻り値:

属性の値。指定されたスコープ内に名前が存在しない場合は null。

例外:

IllegalArgumentException - name が空の場合、またはスコープの値が無効の場合。

NullPointerException - 名前が null の場合

removeAttribute

Object removeAttribute(String name,
                       int scope)

指定されたスコープ内の属性を削除します。

パラメータ:

name - 削除する属性の名前

scope - 属性を削除するスコープ

戻り値:

削除された値。

例外:

IllegalArgumentException - name が空の場合、またはスコープが無効の場合。

NullPointerException - 名前が null の場合

getAttribute

Object getAttribute(String name)

スコープ内で、指定された名前を持つ属性の値を検索し、最初に見つかったものを取得します。検索の順序は、スコープパラメータの数値によって決まります (最小のスコープ値が先)。

パラメータ:

name - 取得する属性の名前。

戻り値:

指定された名前を持つ属性が定義されている最小のスコープ内の属性値。指定された名前を持つ属性がどのスコープにも存在しない場合は null。

例外:

NullPointerException - 名前が null の場合

IllegalArgumentException - 名前が空の場合。

getAttributesScope

int getAttributesScope(String name)

属性が定義されている最小のスコープを取得します。

パラメータ:

name - 属性の名前

戻り値:

最小のスコープ。指定された名前を持つ属性がどのスコープでも定義されていない場合は -1。

例外:

NullPointerException - name が null の場合。

IllegalArgumentException - name が空の場合。

getWriter

Writer getWriter()

出力を表示するときに使用するスクリプトの Writer を返します。

戻り値:

Writer

getErrorWriter

Writer getErrorWriter()

エラー出力を表示するときに使用する Writer を返します。

戻り値:

Writer

setWriter

void setWriter(Writer writer)

出力を表示するときに使用するスクリプトの Writer を設定します。

パラメータ:

writer - 新しい Writer

setErrorWriter

void setErrorWriter(Writer writer)

エラー出力を表示するときに使用する Writer を設定します。

パラメータ:

writer - Writer

getReader

Reader getReader()

入力を読み込むためにスクリプトが使用する Reader を返します。

戻り値:

Reader

setReader

void setReader(Reader reader)

入力を読み込むためのスクリプトの Reader を設定します。

パラメータ:

reader - 新しい Reader

getScopes

List<Integer> getScopes()

ScriptContext 内のスコープに対する、すべての有効値の不変の List を返します。

戻り値:

スコープ値のリスト