public final class

RhinoScriptEngine

extends AbstractScriptEngine
implements Compilable Invocable
java.lang.Object
   ↳ javax.script.AbstractScriptEngine
     ↳ com.sun.script.javascript.RhinoScriptEngine

Class Overview

Implementation of ScriptEngine using the Mozilla Rhino interpreter.

Summary

[Expand]
Inherited Constants
From interface javax.script.ScriptEngine
[Expand]
Inherited Fields
From class javax.script.AbstractScriptEngine
Public Constructors
RhinoScriptEngine()
Creates a new instance of RhinoScriptEngine
Public Methods
CompiledScript compile(Reader script)
Compiles the script (source read from Reader) for later execution.
CompiledScript compile(String script)
Compiles the script (source represented as a String) for later execution.
Bindings createBindings()
Object eval(Reader reader, ScriptContext ctxt)
Object eval(String script, ScriptContext ctxt)
ScriptEngineFactory getFactory()
<T> T getInterface(Class<T> clasz)
Returns an implementation of an interface using functions compiled in the interpreter.
<T> T getInterface(Object thiz, Class<T> clasz)
Returns an implementation of an interface using member functions of a scripting object compiled in the interpreter.
Object invokeFunction(String name, Object... args)
Used to call top-level procedures and functions defined in scripts.
Object invokeMethod(Object thiz, String name, Object... args)
Calls a method on a script object compiled during a previous script execution, which is retained in the state of the ScriptEngine.
static void main(String[] args)
[Expand]
Inherited Methods
From class javax.script.AbstractScriptEngine
From class java.lang.Object
From interface javax.script.Compilable
From interface javax.script.Invocable
From interface javax.script.ScriptEngine

Public Constructors

public RhinoScriptEngine ()

Creates a new instance of RhinoScriptEngine

Public Methods

public CompiledScript compile (Reader script)

Compiles the script (source read from Reader) for later execution. Functionality is identical to compile(String) other than the way in which the source is passed.

Parameters
script The reader from which the script source is obtained.
Returns
  • An implementation of CompiledScript to be executed later using one of its eval methods of CompiledScript.
Throws
ScriptException

public CompiledScript compile (String script)

Compiles the script (source represented as a String) for later execution.

Parameters
script The source of the script, represented as a String.
Returns
  • An subclass of CompiledScript to be executed later using one of the eval methods of CompiledScript.
Throws
ScriptException

public Bindings createBindings ()

public Object eval (Reader reader, ScriptContext ctxt)

Throws
ScriptException

public Object eval (String script, ScriptContext ctxt)

Throws
ScriptException

public ScriptEngineFactory getFactory ()

public T getInterface (Class<T> clasz)

Returns an implementation of an interface using functions compiled in the interpreter. The methods of the interface may be implemented using the invokeFunction method.

Parameters
clasz The Class object of the interface to return.
Returns
  • An instance of requested interface - null if the requested interface is unavailable, i. e. if compiled functions in the ScriptEngine cannot be found matching the ones in the requested interface.

public T getInterface (Object thiz, Class<T> clasz)

Returns an implementation of an interface using member functions of a scripting object compiled in the interpreter. The methods of the interface may be implemented using the invokeMethod method.

Parameters
thiz The scripting object whose member functions are used to implement the methods of the interface.
clasz The Class object of the interface to return.
Returns
  • An instance of requested interface - null if the requested interface is unavailable, i. e. if compiled methods in the ScriptEngine cannot be found matching the ones in the requested interface.

public Object invokeFunction (String name, Object... args)

Used to call top-level procedures and functions defined in scripts.

Parameters
args Arguments to pass to the procedure or function
Returns
  • The value returned by the procedure or function
Throws
NoSuchMethodException
ScriptException

public Object invokeMethod (Object thiz, String name, Object... args)

Calls a method on a script object compiled during a previous script execution, which is retained in the state of the ScriptEngine.

Parameters
thiz If the procedure is a member of a class defined in the script and thiz is an instance of that class returned by a previous execution or invocation, the named method is called through that instance.
name The name of the procedure to be called.
args Arguments to pass to the procedure. The rules for converting the arguments to scripting variables are implementation-specific.
Returns
  • The value returned by the procedure. The rules for converting the scripting variable returned by the script method to a Java Object are implementation-specific.
Throws
NoSuchMethodException
ScriptException

public static void main (String[] args)

Throws
Exception