ScriptEngine (Java Platform SE 7)

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

AbstractScriptEngine
```
public interface ScriptEngine
```
ScriptEngine は、この仕様のすべての実装で完全に機能することが必要なメソッドを持つ基本インタフェースです。

これらのメソッドは、基本的なスクリプト機能を提供します。この単純なインタフェースに記述されたアプリケーションは、どの実装でも最小限の変更で動作することが想定されています。スクリプトを実行するメソッド、値を設定および取得するメソッドが含まれます。

値は、2 種類のキーと値のペアです。1 つ目のタイプのペアでは、各ペアのキーは予約済みで、この仕様または個別の実装によって定義されます。予約済みのキーを持つペア内の値は、指定された意味を持ちます。

もう一方のタイプのペアでは、各ペアは Java 言語の Bindings を作成します。通常、値はスクリプト内で、対応するキーまたはそれらのデコレートされた形式によって表されます。

導入されたバージョン:

1.6

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static String`	`ARGV` 位置引数の配列をスクリプトに渡す名前付き値の予約済みキーです。
`static String`	`ENGINE` `ScriptEngine` 実装の名前である名前付き値の予約済みキーです。
`static String`	`ENGINE_VERSION` `ScriptEngine` 実装のバージョンを識別する名前付き値の予約済みキーです。
`static String`	`FILENAME` 実行中のファイルの名前である名前付き値の予約済みキーです。
`static String`	`LANGUAGE` 実装がサポートするスクリプト言語の完全な名前である名前付き値の予約済みキーです。
`static String`	`LANGUAGE_VERSION` 実装がサポートするスクリプト言語のバージョンを識別する名前付き値の予約済みキーです。
`static String`	`NAME` スクリプト言語の短い名前を識別する名前付き値の予約済みキーです。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`Bindings`	`createBindings()` 初期化されていない `Bindings` を返します。
`Object`	`eval(Reader reader)` スクリプトのソースが `Reader` として提供されることを除いて、`eval(String)` と同じです。
`Object`	`eval(Reader reader, Bindings n)` スクリプトのソースが `Reader` として提供されることを除いて、`eval(String, Bindings)` と同じです。
`Object`	`eval(Reader reader, ScriptContext context)` スクリプトのソースが `Reader` から読み込まれる場合、`eval(String, ScriptContext)` と同じです。
`Object`	`eval(String script)` 指定されたスクリプトを実行します。
`Object`	`eval(String script, Bindings n)` スクリプトの実行中に、`Bindings` 引数を `ScriptEngine` の `ENGINE_SCOPE` `Bindings` として使用します。
`Object`	`eval(String script, ScriptContext context)` ソースが 1 番目の引数として渡された String であるスクリプトをただちに実行します。
`Object`	`get(String key)` このエンジンの状態の値セットを取得します。
`Bindings`	`getBindings(int scope)` 名前付き値のスコープを返します。
`ScriptContext`	`getContext()` `ScriptContext` が指定されていない場合にスクリプトの実行に使用される Bindings、Reader、および Writer を持つ `ScriptEngine` のデフォルトの `ScriptContext` を返します。
`ScriptEngineFactory`	`getFactory()` この `ScriptEngine` が属するクラスの `ScriptEngineFactory` を返します。
`void`	`put(String key, Object value)` ScriptEngine の状態にキーと値のペアを設定します。キーが予約されているかどうかに基づいて、スクリプトの実行時、またはほかの方法で使用される Java 言語バインディングが設定されます。
`void`	`setBindings(Bindings bindings, int scope)` スクリプトによって使用される名前付き値のスコープを設定します。
`void`	`setContext(ScriptContext context)` `ScriptContext` が指定されていない場合にスクリプトの実行に使用される Bindings、Reader、および Writer を持つ `ScriptEngine` のデフォルトの `ScriptContext` を設定します。

- フィールドの詳細
  - ARGV
```
static final String ARGV
```
    位置引数の配列をスクリプトに渡す名前付き値の予約済みキーです。
    
    関連項目:
    定数フィールド値
  - FILENAME
```
static final String FILENAME
```
    実行中のファイルの名前である名前付き値の予約済みキーです。
    
    関連項目:
    定数フィールド値
  - ENGINE
```
static final String ENGINE
```
    ScriptEngine 実装の名前である名前付き値の予約済みキーです。
    
    関連項目:
    定数フィールド値
  - ENGINE_VERSION
```
static final String ENGINE_VERSION
```
    ScriptEngine 実装のバージョンを識別する名前付き値の予約済みキーです。
    
    関連項目:
    定数フィールド値
  - NAME
```
static final String NAME
```
    スクリプト言語の短い名前を識別する名前付き値の予約済みキーです。この名前は、ScriptEngineManager が、getEngineByName メソッドに指定された名前で ScriptEngine を検索するときに使用します。
    
    関連項目:
    定数フィールド値
  - LANGUAGE
```
static final String LANGUAGE
```
    実装がサポートするスクリプト言語の完全な名前である名前付き値の予約済みキーです。
    
    関連項目:
    定数フィールド値
  - LANGUAGE_VERSION
```
static final String LANGUAGE_VERSION
```
    実装がサポートするスクリプト言語のバージョンを識別する名前付き値の予約済みキーです。
    
    関連項目:
    定数フィールド値
- メソッドの詳細
  - eval
```
Object eval(String script,
          ScriptContext context)
            throws ScriptException
```
    ソースが 1 番目の引数として渡された String であるスクリプトをただちに実行します。スクリプトは、実行前に再解析または再コンパイルされる可能性があります。変数値およびコンパイル済み手続きを含む、以前の実行でエンジンに残された状態は、この実行中に可視である可能性があります。
    
    パラメータ:
    script - スクリプトエンジンによって実行されるスクリプト。
    context - 異なるスコープ内の属性セットを公開する ScriptContext。スコープ ScriptContext.ENGINE_SCOPE および ScriptContext.GLOBAL_SCOPE の意味は、仕様で定義されている。
    
    ScriptContext の ENGINE_SCOPE Bindings には、このスクリプトの実行中に使用される、アプリケーションオブジェクトへのスクリプト変数のバインディングが含まれます。
    
    戻り値:
    スクリプトの実行によって返される値。
    
    例外:
    
    ScriptException - スクリプトでエラーが発生した場合。ScriptEngines は、基本となるスクリプトの実装によってスローされたチェック例外の ScriptException ラッパーを作成およびスローする必要があります。
    
    NullPointerException - どちらかの引数が null である場合。
  - eval
```
Object eval(Reader reader,
          ScriptContext context)
            throws ScriptException
```
    スクリプトのソースが Reader から読み込まれる場合、eval(String, ScriptContext) と同じです。
    
    パラメータ:
    reader - スクリプトエンジンによって実行されるスクリプトのソース。
    context - スクリプトエンジンに渡される ScriptContext。
    
    戻り値:
    スクリプトの実行によって返される値。
    
    例外:
    
    ScriptException - スクリプトでエラーが発生した場合。
    
    NullPointerException - どちらかの引数が null である場合。
  - eval
```
Object eval(String script)
            throws ScriptException
```
    指定されたスクリプトを実行します。ScriptEngine のデフォルトの ScriptContext が使用されます。
    
    パラメータ:
    script - 実行されるスクリプト言語ソース。
    
    戻り値:
    スクリプトの実行によって返される値。
    
    例外:
    
    ScriptException - スクリプトでエラーが発生した場合。
    
    NullPointerException - 引数が null である場合。
  - eval
```
Object eval(Reader reader)
            throws ScriptException
```
    スクリプトのソースが Reader として提供されることを除いて、eval(String) と同じです。
    
    パラメータ:
    reader - スクリプトのソース。
    
    戻り値:
    スクリプトによって返される値。
    
    例外:
    
    ScriptException - スクリプトでエラーが発生した場合。
    
    NullPointerException - 引数が null である場合。
  - eval
```
Object eval(String script,
          Bindings n)
            throws ScriptException
```
    スクリプトの実行中に、Bindings 引数を ScriptEngine の ENGINE_SCOPE Bindings として使用します。デフォルトの ScriptContext の Reader、Writer、および ENGINE_SCOPE 以外の Bindings が使用されます。ScriptEngine の ENGINE_SCOPE Bindings は変更されず、そのマッピングもスクリプトの実行によって変更されません。
    
    パラメータ:
    script - スクリプトのソース。
    n - スクリプトの実行に使用される属性の Bindings。
    
    戻り値:
    スクリプトによって返される値。
    
    例外:
    
    ScriptException - スクリプトでエラーが発生した場合。
    
    NullPointerException - どちらかの引数が null である場合。
  - eval
```
Object eval(Reader reader,
          Bindings n)
            throws ScriptException
```
    スクリプトのソースが Reader として提供されることを除いて、eval(String, Bindings) と同じです。
    
    パラメータ:
    reader - スクリプトのソース。
    n - 属性の Bindings。
    
    戻り値:
    スクリプトによって返される値。
    
    例外:
    
    ScriptException - エラーが発生した場合。
    
    NullPointerException - どちらかの引数が null である場合。
  - put
```
void put(String key,
       Object value)
```
    ScriptEngine の状態にキーと値のペアを設定します。キーが予約されているかどうかに基づいて、スクリプトの実行時、またはほかの方法で使用される Java 言語バインディングが設定されます。getBindings(ScriptContext.ENGINE_SCOPE).put と同じ結果になります。
    
    パラメータ:
    key - 追加する名前付き値の名前
    value - 追加する名前付き値の値。
    
    例外:
    
    NullPointerException - キーが null の場合。
    
    IllegalArgumentException - key が空の場合。
  - get
```
Object get(String key)
```
    このエンジンの状態の値セットを取得します。値は、実装に応じて、setValue を使用して設定された値、または ScriptEngine の状態のほかの値になります。getBindings(ScriptContext.ENGINE_SCOPE).get と同じ結果になります。
    
    パラメータ:
    key - 値が返されるキー
    
    戻り値:
    指定されたキーの値
    
    例外:
    
    NullPointerException - キーが null の場合。
    
    IllegalArgumentException - key が空の場合。
  - getBindings
```
Bindings getBindings(int scope)
```
    名前付き値のスコープを返します。有効なスコープは次のとおりです。
    - ScriptContext.GLOBAL_SCOPE - グローバルスコープを表す名前付き値のセット。この ScriptEngine が ScriptEngineManager によって作成される場合、マネージャーはグローバルスコープバインディングを設定します。この ScriptEngine に関連付けられたグローバルスコープが存在しない場合は null です。
    - ScriptContext.ENGINE_SCOPE - この ScriptEngine の状態を表す名前付き値のセット。通常、値は関連付けられたキーを変数名として使用するスクリプトで可視です。
    - その他、ScriptEngine のデフォルトの ScriptContext 内で定義されているスコープの値。
    返される Bindings インスタンスは、ScriptEngine のデフォルトの ScriptContext で対応する引数を指定して呼び出された ScriptContext の getBindings メソッドによって返されるインスタンスと同じである必要があります。
    パラメータ:
    scope - 返す Bindings を指定する ScriptContext.ENGINE_SCOPE または ScriptContext.GLOBAL_SCOPE。ScriptContext の実装では、追加のスコープを定義できる。ScriptEngine のデフォルトの ScriptContext が追加のスコープを定義している場合、それらのいずれかを渡して、対応する Bindings を取得可能。
    
    戻り値:
    指定されたスコープを持つ Bindings。
    
    例外:
    
    IllegalArgumentException - 指定されたスコープが無効な場合
  - setBindings
```
void setBindings(Bindings bindings,
               int scope)
```
    スクリプトによって使用される名前付き値のスコープを設定します。有効なスコープは次のとおりです。
    - ScriptContext.ENGINE_SCOPE - 指定された Bindings によって、ScriptEngine のエンジンスコープが置換されます。
    - ScriptContext.GLOBAL_SCOPE - 指定された Bindings は GLOBAL_SCOPE として可視でなければなりません。
    - その他、ScriptEngine のデフォルトの ScriptContext 内で定義されているスコープの値。
    このメソッドは、ScriptEngine のデフォルトの ScriptContext 上で scope の対応する値を指定して ScriptContext の setBindings メソッドを呼び出した場合と同じ結果になります。
    パラメータ:
    bindings - 指定されたスコープの Bindings。
    scope - 指定されたスコープ。ScriptContext.ENGINE_SCOPE、ScriptContext.GLOBAL_SCOPE、またはその他のスコープの有効値のいずれか。
    
    例外:
    
    IllegalArgumentException - スコープが無効な場合
    
    NullPointerException - bindings が null で、スコープが ScriptContext.ENGINE_SCOPE である場合
  - createBindings
```
Bindings createBindings()
```
    初期化されていない Bindings を返します。
    
    戻り値:
    この ScriptEngine の状態を置換するために使用可能な Bindings。
  - getContext
```
ScriptContext getContext()
```
    ScriptContext が指定されていない場合にスクリプトの実行に使用される Bindings、Reader、および Writer を持つ ScriptEngine のデフォルトの ScriptContext を返します。
    
    戻り値:
    ScriptEngine のデフォルトの ScriptContext。
  - setContext
```
void setContext(ScriptContext context)
```
    ScriptContext が指定されていない場合にスクリプトの実行に使用される Bindings、Reader、および Writer を持つ ScriptEngine のデフォルトの ScriptContext を設定します。
    
    パラメータ:
    context - ScriptEngine のデフォルトの ScriptContext を置換する ScriptContext。
    
    例外:
    
    NullPointerException - context が null の場合。
  - getFactory
```
ScriptEngineFactory getFactory()
```
    この ScriptEngine が属するクラスの ScriptEngineFactory を返します。
    
    戻り値:
    ScriptEngineFactory

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

インタフェース ScriptEngine

フィールドのサマリー

メソッドのサマリー

フィールドの詳細

ARGV

FILENAME

ENGINE

ENGINE_VERSION

NAME

LANGUAGE

LANGUAGE_VERSION

メソッドの詳細

eval

eval

eval

eval

eval

eval

put

get

getBindings

setBindings

createBindings

getContext

setContext

getFactory