de.ipcon.tools

Interface ScriptFunctionI

All Known Implementing Classes:

GroovyClosureScriptFunction, GroovyScript.Function

public interface ScriptFunctionI

Defines the contract for a function that can be invoked within a scripting environment.

This interface provides a set of overloaded "invoke" methods that allow for flexible execution of a script function with or without parameters, and for returning values of different types with optional default values.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	invoke() Invokes the script function without any parameters.
java.lang.Object	invoke(java.lang.Object nullValue) Invokes the script function without any parameters, providing a default value to return if the result is null.
java.lang.Object	invoke(java.lang.Object[] parms) Invokes the script function with an array of parameters.
java.lang.Object	invoke(java.lang.Object[] parms, java.lang.Object nullValue) Invokes the script function with an array of parameters and a default value to return if the result is null.
boolean	invokeAsBool(java.lang.Object[] parms) Invokes the script function with an array of parameters and returns a boolean value.
boolean	invokeAsBool(java.lang.Object[] parms, boolean nullValue) Invokes the script function with an array of parameters and returns a boolean value.
java.lang.String	invokeAsString(java.lang.Object[] parms) Invokes the script function with an array of parameters and returns a String value.
java.lang.String	invokeAsString(java.lang.Object[] parms, java.lang.String nullValue) Invokes the script function with an array of parameters and returns a String value.

Method Detail

invoke

java.lang.Object invoke()

Invokes the script function without any parameters.

Returns:

The result of the function's execution as an Object.

invoke

java.lang.Object invoke(java.lang.Object nullValue)

Invokes the script function without any parameters, providing a default value to return if the result is null.

Parameters:

nullValue - The default value to be returned if the function's result is null.

Returns:

The result of the function's execution, or nullValue if the result is null.

invoke

java.lang.Object invoke(java.lang.Object[] parms,
                        java.lang.Object nullValue)

Invokes the script function with an array of parameters and a default value to return if the result is null.

Parameters:

parms - An array of Objects to be passed as parameters to the function.

nullValue - The default value to be returned if the function's result is null.

Returns:

The result of the function's execution, or nullValue if the result is null.

invoke

java.lang.Object invoke(java.lang.Object[] parms)

Invokes the script function with an array of parameters.

Parameters:

parms - An array of Objects to be passed as parameters to the function.

Returns:

The result of the function's execution as an Object.

invokeAsBool

boolean invokeAsBool(java.lang.Object[] parms,
                     boolean nullValue)

Invokes the script function with an array of parameters and returns a boolean value.

Parameters:

parms - An array of Objects to be passed as parameters to the function.

nullValue - The default boolean value to be returned if the function's result is null.

Returns:

The boolean result of the function's execution, or nullValue if the result is null.

invokeAsBool

boolean invokeAsBool(java.lang.Object[] parms)

Invokes the script function with an array of parameters and returns a boolean value.

Parameters:

parms - An array of Objects to be passed as parameters to the function.

Returns:

The boolean result of the function's execution.

invokeAsString

java.lang.String invokeAsString(java.lang.Object[] parms,
                                java.lang.String nullValue)

Invokes the script function with an array of parameters and returns a String value.

Parameters:

parms - An array of Objects to be passed as parameters to the function.

nullValue - The default String value to be returned if the function's result is null.

Returns:

The String result of the function's execution, or nullValue if the result is null.

invokeAsString

java.lang.String invokeAsString(java.lang.Object[] parms)

Invokes the script function with an array of parameters and returns a String value.

Parameters:

parms - An array of Objects to be passed as parameters to the function.

Returns:

The String result of the function's execution.