| javax.script.ScriptEngine
All known Subclasses: javax.script.AbstractScriptEngine,
| ScriptEngine | | public interface ScriptEngine (Code) | | ScriptEngine is the fundamental interface whose methods must be
fully functional in every implementation of this specification.
These methods provide basic scripting functionality. Applications written to this
simple interface are expected to work with minimal modifications in every implementation.
It includes methods that execute scripts, and ones that set and get values.
The values are key/value pairs of two types. The first type of pairs consists of
those whose keys are reserved and defined in this specification or by individual
implementations. The values in the pairs with reserved keys have specified meanings.
The other type of pairs consists of those that create Java language Bindings, the values are
usually represented in scripts by the corresponding keys or by decorated forms of them.
author:
Mike Grogan
version:
1.0
since:
1.6 |
| Field Summary | |
| final public static String | ARGV
Reserved key for a named value that passes
an array of positional arguments to a script. | | final public static String | ENGINE
Reserved key for a named value that is
the name of the ScriptEngine implementation. | | final public static String | ENGINE_VERSION
Reserved key for a named value that identifies
the version of the ScriptEngine implementation. | | final public static String | FILENAME
Reserved key for a named value that is
the name of the file being executed. | | final public static String | LANGUAGE
Reserved key for a named value that is
the full name of Scripting Language supported by the implementation. | | final public static String | LANGUAGE_VERSION
Reserved key for the named value that identifies
the version of the scripting language supported by the implementation. | | final public static String | NAME
Reserved key for a named value that identifies
the short name of the scripting language. |
| Method Summary | |
| public Bindings | createBindings()
Returns an uninitialized Bindings. | | public Object | eval(String script, ScriptContext context)
Causes the immediate execution of the script whose source is the String
passed as the first argument. | | public Object | eval(Reader reader, ScriptContext context)
Same as eval(String, ScriptContext) where the source of the script
is read from a Reader.
Parameters:
reader - The source of the script to be executed by the script engine.
Parameters:
context - The ScriptContext passed to the script engine. | | public Object | eval(String script)
Executes the specified script. | | public Object | eval(Reader reader)
| | public Object | eval(String script, Bindings n)
Executes the script using the Bindings argument as the ENGINE_SCOPE
Bindings of the ScriptEngine during the script execution. | | public Object | eval(Reader reader, Bindings n)
Same as eval(String, Bindings) except that the source of the script
is provided as a Reader.
Parameters:
reader - The source of the script.
Parameters:
n - The Bindings of attributes. | | public Object | get(String key)
Retrieves a value set in the state of this engine. | | public Bindings | getBindings(int scope)
Returns a scope of named values. | | public ScriptContext | getContext()
Returns the default ScriptContext of the ScriptEngine whose Bindings, Reader
and Writers are used for script executions when no ScriptContext is specified. | | public ScriptEngineFactory | getFactory()
Returns a ScriptEngineFactory for the class to which this ScriptEngine belongs. | | public void | put(String key, Object value)
Sets a key/value pair in the state of the ScriptEngine that may either create
a Java Language Binding to be used in the execution of scripts or be used in some
other way, depending on whether the key is reserved. | | public void | setBindings(Bindings bindings, int scope)
Sets a scope of named values to be used by scripts. | | public void | setContext(ScriptContext context)
Sets the default code>ScriptContext of the ScriptEngine whose Bindings, Reader
and Writers are used for script executions when no ScriptContext is specified. |
| ARGV | | final public static String ARGV(Code) | | Reserved key for a named value that passes
an array of positional arguments to a script.
|
| ENGINE | | final public static String ENGINE(Code) | | Reserved key for a named value that is
the name of the ScriptEngine implementation.
|
| ENGINE_VERSION | | final public static String ENGINE_VERSION(Code) | | Reserved key for a named value that identifies
the version of the ScriptEngine implementation.
|
| FILENAME | | final public static String FILENAME(Code) | | Reserved key for a named value that is
the name of the file being executed.
|
| LANGUAGE | | final public static String LANGUAGE(Code) | | Reserved key for a named value that is
the full name of Scripting Language supported by the implementation.
|
| LANGUAGE_VERSION | | final public static String LANGUAGE_VERSION(Code) | | Reserved key for the named value that identifies
the version of the scripting language supported by the implementation.
|
| NAME | | final public static String NAME(Code) | | Reserved key for a named value that identifies
the short name of the scripting language. The name is used by the
ScriptEngineManager to locate a ScriptEngine
with a given name in the getEngineByName method.
|
| createBindings | | public Bindings createBindings()(Code) | | Returns an uninitialized Bindings.
A Bindings that can be used to replace the state of this ScriptEngine. |
| eval | | public Object eval(String script, ScriptContext context) throws ScriptException(Code) | | Causes the immediate execution of the script whose source is the String
passed as the first argument. The script may be reparsed or recompiled before
execution. State left in the engine from previous executions, including
variable values and compiled procedures may be visible during this execution.
Parameters:
script - The script to be executed by the script engine.
Parameters:
context - A ScriptContext exposing sets of attributes indifferent scopes. The meanings of the scopes ScriptContext.GLOBAL_SCOPE,and ScriptContext.ENGINE_SCOPE are defined in the specification.
The ENGINE_SCOPE Bindings of the ScriptContext contains thebindings of scripting variables to application objects to be used during thisscript execution. The value returned from the execution of the script.
throws:
ScriptException - if an error occurrs. ScriptEngines should create and throwScriptException wrappers for checked Exceptions thrown by underlying scriptingimplementations.
throws:
NullPointerException - if either argument is null. |
| eval | | public Object eval(Reader reader, ScriptContext context) throws ScriptException(Code) | | Same as eval(String, ScriptContext) where the source of the script
is read from a Reader.
Parameters:
reader - The source of the script to be executed by the script engine.
Parameters:
context - The ScriptContext passed to the script engine. The value returned from the execution of the script.
throws:
ScriptException - if an error occurrs.
throws:
NullPointerException - if either argument is null. |
| eval | | public Object eval(String script) throws ScriptException(Code) | | Executes the specified script. The default ScriptContext for the ScriptEngine
is used.
Parameters:
script - The script language source to be executed. The value returned from the execution of the script.
throws:
ScriptException - if error occurrs.
throws:
NullPointerException - if the argument is null. |
| eval | | public Object eval(Reader reader) throws ScriptException(Code) | | Same as eval(String) except that the source of the script is
provided as a Reader
The value returned by the script.
Parameters:
reader - The source of the script.
throws:
ScriptExcepion - if an error occurrs.
throws:
NullPointerException - if the argument is null. |
| eval | | public Object eval(String script, Bindings n) throws ScriptException(Code) | | Executes the script using the Bindings argument as the ENGINE_SCOPE
Bindings of the ScriptEngine during the script execution. The
Reader, Writer and non-ENGINE_SCOPE Bindings of the
default ScriptContext are used. The ENGINE_SCOPE
Bindings of the ScriptEngine is not changed, and its
mappings are unaltered by the script execution.
Parameters:
script - The source for the script.
Parameters:
n - The Bindings of attributes to be used for script execution. The value returned by the script.
throws:
ScriptException - if an error occurrs.
throws:
NullPointerException - if either argument is null. |
| eval | | public Object eval(Reader reader, Bindings n) throws ScriptException(Code) | | Same as eval(String, Bindings) except that the source of the script
is provided as a Reader.
Parameters:
reader - The source of the script.
Parameters:
n - The Bindings of attributes. The value returned by the script.
throws:
ScriptException - if an error occurrs.
throws:
NullPointerException - if either argument is null. |
| get | | public Object get(String key)(Code) | | Retrieves a value set in the state of this engine. The value might be one
which was set using setValue or some other value in the state
of the ScriptEngine, depending on the implementation. Must have the same effect
as getBindings(ScriptContext.ENGINE_SCOPE).get
Parameters:
key - The key whose value is to be returned the value for the given key |
| getBindings | | public Bindings getBindings(int scope)(Code) | | Returns a scope of named values. The possible scopes are:
ScriptContext.GLOBAL_SCOPE - A set of named values shared by all ScriptEngines
created by the same ScriptEngineFactory. If the ScriptEngine is created by a
ScriptEngineManager, a reference to the global scope stored by the
ScriptEngineManager should be returned. May return null if no global scope
is associated with this ScriptEngineScriptContext.ENGINE_SCOPE - The set of named values representing the state of
this ScriptEngine. The values are generally visible in scripts using
the associated keys as variable names.- Any other value of scope defined in the default
ScriptContext of the ScriptEngine.
The Bindings instances that are returned must be identical to those returned by the
getBindings method of ScriptContext called with corresponding arguments on
the default ScriptContext of the ScriptEngine.
Parameters:
scope - Either ScriptContext.ENGINE_SCOPE or ScriptContext.GLOBAL_SCOPEwhich specifies the Bindings to return. Implementations of ScriptContextmay define additional scopes. If the default ScriptContext of the ScriptEnginedefines additional scopes, any of them can be passed to get the corresponding Bindings. The Bindings with the specified scope.
throws:
IllegalArgumentException - if specified scope is invalid |
| getContext | | public ScriptContext getContext()(Code) | | Returns the default ScriptContext of the ScriptEngine whose Bindings, Reader
and Writers are used for script executions when no ScriptContext is specified.
The default ScriptContext of the ScriptEngine. |
| getFactory | | public ScriptEngineFactory getFactory()(Code) | | Returns a ScriptEngineFactory for the class to which this ScriptEngine belongs.
The returned ScriptEngineFactory implements ScriptEngineInfo, which describes
attributes of this ScriptEngine implementation.
The ScriptEngineFactory |
| put | | public void put(String key, Object value)(Code) | | Sets a key/value pair in the state of the ScriptEngine that may either create
a Java Language Binding to be used in the execution of scripts or be used in some
other way, depending on whether the key is reserved. Must have the same effect as
getBindings(ScriptContext.ENGINE_SCOPE).put.
Parameters:
key - The name of named value to add
Parameters:
value - The value of named value to add.
throws:
IllegalArgumentException - if key is null or not a String. |
| setBindings | | public void setBindings(Bindings bindings, int scope)(Code) | | Sets a scope of named values to be used by scripts. The possible scopes are:
ScriptContext.ENGINE_SCOPE - The specified Bindings replaces the
engine scope of the ScriptEngine.
ScriptContext.GLOBAL_SCOPE - The specified Bindings must be visible
as the GLOBAL_SCOPE.
- Any other value of scope defined in the default
ScriptContext of the ScriptEngine.
The method must have the same effect as calling the setBindings method of
ScriptContext with the corresponding value of scope on the default
ScriptContext of the ScriptEngine.
Parameters:
bindings - The Bindings for the specified scope.
Parameters:
scope - The specified scope. Either ScriptContext.ENGINE_SCOPE,ScriptContext.GLOBAL_SCOPE, or any other valid value of scope.
throws:
IllegalArgumentException - if the scope is invalid |
| setContext | | public void setContext(ScriptContext context)(Code) | | Sets the default code>ScriptContext of the ScriptEngine whose Bindings, Reader
and Writers are used for script executions when no ScriptContext is specified.
Parameters:
context - - A ScriptContext that will replace the default ScriptContext inthe ScriptEngine. |
|
|