OpenJDK 27 · javax.script.Invocable · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public < the type of the interface to return T> T	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(Class<T> The `Class` object of the interface to return. clasz) Returns an implementation of an interface using functions compiled in the interpreter.
public < the type of the interface to return T> T	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. getInterface(Object The scripting object whose member functions are used to implement the methods of the interface. thiz, Class<T> The `Class` object of the interface to return. clasz) Returns an implementation of an interface using member functions of a scripting object compiled in the interpreter.
public Object	Returns: The value returned by the procedure or function invokeFunction(String of the procedure or function to call name, Object... Arguments to pass to the procedure or function args) Used to call top-level procedures and functions defined in scripts.
public Object	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. invokeMethod(Object 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. thiz, String The name of the procedure to be called. name, Object... Arguments to pass to the procedure. The rules for converting the arguments to scripting variables are implementation-specific. 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 back to summary

getInterface	back to summary
public <T> 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 <T> the type of the interface to return clasz:Class<T> The `Class` object of the interface to return. Returns:T 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. Exceptions IllegalArgumentException: if the specified `Class` object is null or is not an interface.

public <T> 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

<T>: the type of the interface to return
clasz:Class<T>: The Class object of the interface to return.

Returns:T

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.

Exceptions

IllegalArgumentException:: if the specified Class object is null or is not an interface.

getInterface back to summary

getInterface	back to summary
public <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. The methods of the interface may be implemented using the `invokeMethod` method. Parameters <T> the type of the interface to return thiz:Object The scripting object whose member functions are used to implement the methods of the interface. clasz:Class<T> The `Class` object of the interface to return. Returns:T 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. Exceptions 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 <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. The methods of the interface may be implemented using the invokeMethod method.

Parameters

<T>: the type of the interface to return
thiz:Object: The scripting object whose member functions are used to implement the methods of the interface.
clasz:Class<T>: The Class object of the interface to return.

Returns:T

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.

Exceptions

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.

invokeFunction	back to summary
public Object invokeFunction(String name, Object... args) throws ScriptException, NoSuchMethodException Used to call top-level procedures and functions defined in scripts. Parameters name:String of the procedure or function to call args:Object[] Arguments to pass to the procedure or function Returns:Object The value returned by the procedure or function Exceptions ScriptException: if an error occurs during invocation of the method. NoSuchMethodException: if method with given name or matching argument types cannot be found. NullPointerException: if method name is null.

invokeFunction

back to summary

public Object invokeFunction(String name, Object... args) throws ScriptException, NoSuchMethodException

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

Parameters

name:String: of the procedure or function to call
args:Object[]: Arguments to pass to the procedure or function

Returns:Object

The value returned by the procedure or function

Exceptions

ScriptException:: if an error occurs during invocation of the method.
NoSuchMethodException:: if method with given name or matching argument types cannot be found.
NullPointerException:: if method name is null.

invokeMethod back to summary

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

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:Object: 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:String: The name of the procedure to be called.
args:Object[]: Arguments to pass to the procedure. The rules for converting the arguments to scripting variables are implementation-specific.

Returns:Object

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.

Exceptions

ScriptException:: if an error occurs during invocation of the method.
NoSuchMethodException:: if method with given name or matching argument types cannot be found.
NullPointerException:: if the method name is null.
IllegalArgumentException:: if the specified thiz is null or the specified Object is does not represent a scripting object.

public Interface Invocable

Method Summary

Method Detail