モジュール java.scripting

パッケージ javax.script

インタフェースScriptContext

既知のすべての実装クラス:

SimpleScriptContext

public interface ScriptContext

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

導入されたバージョン:

1.6

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static final int	ENGINE_SCOPE	EngineScope属性は、単一のScriptEngineの寿命を通じて可視です。また、属性のセットはエンジンごとに保持されます。
static final 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を取得します。

パラメータ:

scope - スコープ

戻り値:

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

例外:

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

setAttribute

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

指定されたスコープ内の属性の値を設定します。 スコープがGLOBAL_SCOPEで、GLOBAL_SCOPEにバインディングが設定されていない場合、setAttributeコールはno-opです。

パラメータ:

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を返します。

戻り値:

スコープ値のリスト