|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScriptEngine
See Javadoc of Java Scripting API
Field Summary | |
---|---|
static String |
ARGV
Reserved key associated with an object array which is used to pass set of positional parameters to the ScriptEngines. |
static String |
ENGINE
Reserved key associated with the name of the Java ScriptEngine |
static String |
ENGINE_VERSION
Reserved key associated with the version of the Java ScriptEngine |
static String |
FILENAME
Reserved key associated with name of the file which contains the source of the script. |
static String |
LANGUAGE
Reserved key associated with the name of the supported scripting language |
static String |
LANGUAGE_VERSION
Reserved key associated with the version of the supported scripting language |
static String |
NAME
Reserved key associated with the named value which identifies the short name of the supported language |
Method Summary | |
---|---|
Bindings |
createBindings()
Retrieves an uninitialized Bindings which can be used as the scope of the ScriptEngine. |
Object |
eval(Reader reader)
Evaluates a script obtained using the specified reader as the script source. |
Object |
eval(Reader reader,
Bindings bindings)
Evaluates a script obtained using a reader as the script source and using the specified namespace as the ENGINE_SCOPE. |
Object |
eval(Reader reader,
ScriptContext context)
Evaluates a script obtained using the specified reader as the script source and using the bindings in the specifed ScriptContext. |
Object |
eval(String script)
Evaluates a script contained in a String and returns the resultant object. |
Object |
eval(String script,
Bindings bindings)
Evaluates a piece of script using the specified namespace as the ENGINE_SCOPE. |
Object |
eval(String script,
ScriptContext context)
Evaluates a script using the bindings in the specifed ScriptContext. |
Object |
get(String key)
Retrieves the value which is associated with the specified key in the state of the ScriptEngine. |
Bindings |
getBindings(int scope)
Retrieves a reference to the associated bindings for the specified scope. |
ScriptContext |
getContext()
Returns the default ScriptContext of the ScriptEngine whose Bindings, Readers and Writers are used for script executions when no ScriptContext is specified. |
ScriptEngineFactory |
getFactory()
Returns a ScriptEngineFactory for the class to which this ScriptEngine belongs. |
void |
put(String key,
Object value)
Associates a key and a value in the ScriptEngine ENGINE_SCOPE bindings. |
void |
setBindings(Bindings bindings,
int scope)
Associates the specified bindings with the specified scope. |
void |
setContext(ScriptContext context)
Sets the default ScriptContext of the ScriptEngine whose Bindings, Readers and Writers are used for script executions when no ScriptContext is specified. |
Field Detail |
---|
static final String ARGV
static final String FILENAME
static final String ENGINE
static final String ENGINE_VERSION
static final String LANGUAGE
static final String LANGUAGE_VERSION
static final String NAME
Method Detail |
---|
Bindings createBindings()
Object eval(Reader reader) throws ScriptException
reader
- the source of the script
ScriptException
- if an error occurs
NullPointerException
- if argument is nullObject eval(Reader reader, Bindings bindings) throws ScriptException
reader
- the script source used to obtained the scriptbindings
- the bindings to be used as ENGINE_SCOPE
ScriptException
- if an error occurs
NullPointerException
- if either argument is nullObject eval(Reader reader, ScriptContext context) throws ScriptException
reader
- the script sourcecontext
- the context contianing different bindings for
script evaluation
ScriptException
- if an error occurs
NullPointerException
- if either argument is nullObject eval(String script) throws ScriptException
script
- the String representation of the script
ScriptException
- if an error occurs
NullPointerException
- if argument is nullObject eval(String script, Bindings bindings) throws ScriptException
script
- the String representation of the scriptbindings
- the bindings to be used as the ENGINE_SCOPE
ScriptException
- if an error occurs
NullPointerException
- if either argument is nullObject eval(String script, ScriptContext context) throws ScriptException
script
- the String representation of the scriptcontext
- tbe ScriptContext containing bindings for the
script evaluation
ScriptException
- if an error occurs
NullPointerException
- if either argument is nullObject get(String key)
key
- the key associated with value.
IllegalArgumentException
- if argument is empty
NullPointerException
- if argument is nullScriptEngineFactory getFactory()
Bindings getBindings(int scope)
scope
- the specified scope
IllegalArgumentException
- if the scope is invalidvoid put(String key, Object value)
key
- the specified key associated with the valuevalue
- value which is to be associated with the
specified key
IllegalArgumentException
- if the key is empty
NullPointerException
- if key is nullvoid setBindings(Bindings bindings, int scope)
bindings
- bindings to be associated with the specified scopescope
- scope which the bindings should be associated with
IllegalArgumentException
- if the scope is invalid
NullPointerException
- if the bindings is null and the scope is ScriptContext.ENGINE_SCOPEScriptContext getContext()
void setContext(ScriptContext context)
context
- scriptContext that will replace the default ScriptContext in the ScriptEngine.
NullPointerException
- if the context is null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |