FileDocCategorySizeDatePackage
Invocable.javaAPI DocJava SE 6 API4191Tue Jun 10 00:26:26 BST 2008javax.script

Invocable

public interface Invocable
The optional interface implemented by ScriptEngines whose methods allow the invocation of procedures in scripts that have previously been executed.
version
1.0
author
Mike Grogan
author
A. Sundararajan
since
1.6

Fields Summary
Constructors Summary
Methods Summary
public TgetInterface(java.lang.Class 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.

param
clasz The Class object of the interface to return.
return
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.
throws
IllegalArgumentException if the specified Class object is null or is not an interface.

public TgetInterface(java.lang.Object thiz, java.lang.Class 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.

param
thiz The scripting object whose member functions are used to implement the methods of the interface.
param
clasz The Class object of the interface to return.
return
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.
throws
IllegalArgumentException if the specified Class object is null or is not an interface, or if the specified Object is null or does not represent a scripting object.

public java.lang.ObjectinvokeFunction(java.lang.String name, java.lang.Object args)
Used to call top-level procedures and functions defined in scripts.

param
args Arguments to pass to the procedure or function
return
The value returned by the procedure or function
throws
ScriptException if an error occurrs during invocation of the method.
throws
NoSuchMethodException if method with given name or matching argument types cannot be found.
throws
NullPointerException if method name is null.

public java.lang.ObjectinvokeMethod(java.lang.Object thiz, java.lang.String name, java.lang.Object args)
Calls a method on a script object compiled during a previous script execution, which is retained in the state of the ScriptEngine.

param
name The name of the procedure to be called.
param
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.
param
args Arguments to pass to the procedure. The rules for converting the arguments to scripting variables are implementation-specific.
return
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
ScriptException if an error occurrs during invocation of the method.
throws
NoSuchMethodException if method with given name or matching argument types cannot be found.
throws
NullPointerException if the method name is null.
throws
IllegalArgumentException if the specified thiz is null or the specified Object is does not represent a scripting object.