This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.script
interface Invocable


public interface Invocable

The optional interface implemented by ScriptEngines whose methods allow the invocation of procedures in scripts that have previously been executed.


Method Summary
 Object

          Returns an implementation of an interface using functions compiled in the interpreter.
 Object
getInterface(Object thiz, Class 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.
 

Method Detail

getInterface

public Object getInterface(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.

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.

getInterface

public Object getInterface(Object thiz,
                           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.

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.

invokeFunction

public Object invokeFunction(String name,
                             Object[] args)
                      throws ScriptException,
                             NoSuchMethodException
Used to call top-level procedures and functions defined in scripts.

Parameters:
name
args - Arguments to pass to the procedure or function
Returns:
The value returned by the procedure or function
Throws:
ScriptException - if an error occurrs during invocation of the method.
NoSuchMethodException - if method with given name or matching argument types cannot be found.

invokeMethod

public Object invokeMethod(Object thiz,
                           String name,
                           Object[] args)
                    throws ScriptException,
                           NoSuchMethodException
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:
ScriptException - if an error occurrs during invocation of the method.
NoSuchMethodException - if method with given name or matching argument types cannot be found.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.