de.ipcon.tools

Class AbstractScript

java.lang.Object

de.ipcon.tools.AbstractScript

Direct Known Subclasses:

BeanShellScript, GroovyScript

public abstract class AbstractScript
extends java.lang.Object

An abstract base class for scripts that can be executed within the application's context.

This class provides static factory methods to create script instances from either a raw script source string or from an XML Element definition. It handles the parsing, compilation, and execution of scripts in a unified way, supporting various scripting languages like BeanShell and Groovy.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RM_DEFAULT A constant string for the default return mode, which is "script".
static java.lang.String	RM_RESULT A constant string for a return mode of "result".
static java.lang.String	RM_SCRIPT A constant string for a return mode of "script".
static java.lang.String	SL_BEANSHELL A constant string for the "beanshell" scripting language.
static java.lang.String	SL_DEFAULT A constant string for the default scripting language, which is "beanshell".
static java.lang.String	SL_GROOVY A constant string for the "groovy" scripting language.
static java.lang.String[]	STR_VALUES_FALSE An array of strings considered to represent a boolean "false" value.
static java.lang.String[]	STR_VALUES_TRUE An array of strings considered to represent a boolean "true" value.

Constructor Summary

Constructors

Constructor and Description
AbstractScript()

Method Summary

Modifier and Type	Method and Description
boolean	asBool(java.lang.Object o, boolean nullValue) Converts an object to a boolean.
java.lang.String	asString(java.lang.Object o, java.lang.String nullValue) Converts an object to a string.
abstract void	clear() Frees all variables of this script after execution to prevent them from being held "forever" and causing memory leaks.
void	close() Closes this script instance, freeing up resources.
void	compileNT() Compiles the script if it has not been compiled yet.
void	compileNT(int lineOffset) Compiles the script with a specified line offset.
abstract void	compileNT(int lineOffset, java.lang.String errorTip) Compiles the script with a specified line offset and error tip.
abstract ScriptFunctionI	createFunction(java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType) Creates a function from a script source string.
abstract ScriptFunctionI	createFunction(java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String scriptName, java.lang.String functionName) Creates a function from a script source string.
abstract ScriptFunctionI	createFunction(java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String scriptName, java.lang.String functionName, int lineOffset) Creates a function from a script source string.
abstract ScriptFunctionI	createFunction(java.lang.String src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String scriptName, java.lang.String functionName, int lineOffset, java.lang.Object delegate) Creates a function from a script source string.
boolean	evalAsBoolNT(java.lang.String source) Evaluates a string as a script and returns the result as boolean.
boolean	evalAsBoolNT(java.lang.String source, boolean nullValue) Evaluates a string as a script with a specified null value and returns the result as boolean.
boolean	evalAsBoolNT(java.lang.String source, boolean nullValue, int lineOffset) Evaluates a string as a script with a specified null value and line offset and returns the result as boolean.
boolean	evalAsBoolNT(java.lang.String source, boolean nullValue, int lineOffset, java.lang.String errorTip) Evaluates a string as a script with a specified null value and line offset and returns the result as boolean.
java.lang.String	evalAsStringNT(java.lang.String source) Parses the passed script and returns the result as String.
java.lang.String	evalAsStringNT(java.lang.String source, java.lang.String nullValue) Evaluates a string as a script with a specified null value and returns the result as String.
java.lang.String	evalAsStringNT(java.lang.String source, java.lang.String nullValue, int lineOffset) Evaluates a string as a script with a specified null value and line offset and returns the result as String.
java.lang.String	evalAsStringNT(java.lang.String source, java.lang.String nullValue, int lineOffset, java.lang.String errorTip) Evaluates a string as a script with a specified null value and line offset and returns the result as String.
java.lang.Object	evalNT(java.lang.String source) Evaluates a string as a script and returns the results as Object.
java.lang.Object	evalNT(java.lang.String source, java.lang.Object nullValue) Evaluates a string as a script with a specified null value and returns the result as Object.
java.lang.Object	evalNT(java.lang.String source, java.lang.Object nullValue, int lineOffset) Evaluates a string as a script with a specified null value and line offset and returns the result as Object.
abstract java.lang.Object	evalNT(java.lang.String source, java.lang.Object nullValue, int lineOffset, java.lang.String errorTip) Evaluates a string as a script with a specified null value and line offset and returns the result as Object.
static AbstractScript	getInstance() Creates an AbstractScript instance with a wide range of configuration options.
static java.lang.Object	getInstance(electric.xml.Element el) Creates an AbstractScript instance from an XML Element.
static AbstractScript	getInstance(java.lang.String language)
static AbstractScript	getInstance(java.lang.String script, boolean doPrecompile) Creates an AbstractScript instance from a string, intelligently detecting whether the string is an XML definition or raw script source.
static AbstractScript	getInstance(java.lang.String language, java.util.List<ScriptImport> defaultImports) Creates an AbstractScript instance with only language and default imports.
static AbstractScript	getInstance(java.lang.String language, java.lang.String source)
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile)
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile, AbstractScript parent)
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile, AbstractScript parent, java.lang.ClassLoader classLoader)
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile, AbstractScript parent, java.lang.ClassLoader classLoader, java.util.Map initialVars)
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile, AbstractScript parent, java.lang.ClassLoader classLoader, java.util.Map initialVars, java.util.List<ScriptImport> defaultImports)
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile, AbstractScript parent, java.lang.ClassLoader classLoader, java.util.Map initialVars, java.util.List<ScriptImport> defaultImports, java.lang.Class baseClass)
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile, AbstractScript parent, java.lang.ClassLoader classLoader, java.util.Map initialVars, java.util.List<ScriptImport> defaultImports, java.lang.Class baseClass, java.lang.String scriptName)
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile, java.util.List<ScriptImport> defaultImports) Creates an AbstractScript instance from various parameters, using default imports.
static AbstractScript	getInstance(java.lang.String language, java.lang.String source, boolean doPrecompile, java.util.List<ScriptImport> defaultImports, java.lang.String scriptName)
java.lang.String	getInterrupt()
java.lang.String	getJavaSyntaxImports(java.util.List imports) Generates a string of Java import statements from a list of ScriptImport objects.
java.lang.String	getJavaSyntaxImports(java.util.List imports, boolean aliasAllowed)
abstract java.lang.String	getLanguage() Returns the scripting language of this script instance.
java.lang.Object	getNT(java.lang.String name) Gets the value of a variable from the script context.
abstract java.lang.Object	getNT(java.lang.String name, java.lang.Object exValue) Gets the value of a variable from the script context.
abstract java.lang.String	getSource() Returns the source code of this script.
abstract boolean	hasSource() Checks if this script has source code.
static boolean	isScriptException(java.lang.Throwable t) Checks if a Throwable is a script-specific exception.
boolean	runAsBoolNT() Runs the script and returns the result as a boolean.
boolean	runAsBoolNT(boolean nullValue) Runs the script and returns the result as a boolean.
boolean	runAsBoolNT(boolean nullValue, int lineOffset) Runs the script and returns the result as a boolean.
boolean	runAsBoolNT(boolean nullValue, int lineOffset, java.lang.String errorTip) Runs the script and returns the result as a boolean.
java.lang.Object	runAsObjectNT() Runs the script and returns the result as an object, with null as default null value.
java.lang.Object	runAsObjectNT(java.lang.Object nullValue) Runs the script with a specified default null value.
java.lang.Object	runAsObjectNT(java.lang.Object nullValue, int lineOffset) Runs the script with a specified null value and line offset.
abstract java.lang.Object	runAsObjectNT(java.lang.Object nullValue, int lineOffset, java.lang.String errorTip) Runs the script with a specified null value, line offset, and error tip.
java.lang.String	runAsStringNT() Runs the script and returns the result as a string.
java.lang.String	runAsStringNT(java.lang.String nullValue) Runs the script and returns the result as a string.
java.lang.String	runAsStringNT(java.lang.String nullValue, int lineOffset) Runs the script and returns the result as a string.
java.lang.String	runAsStringNT(java.lang.String nullValue, int lineOffset, java.lang.String errorTip) Runs the script and returns the result as a string.
void	runNT() Runs the script and returns its result as an object.
void	runNT(int lineOffset) Runs the script with a specified line offset.
void	runNT(int lineOffset, java.lang.String errorTip) Runs the script with a specified line offset and error tip.
void	setInterrupt(java.lang.String $10)
abstract void	setLineOffset(int lineOffset) Sets an offset for line numbers, used for error reporting.
void	setNT(java.util.Map map) Sets variables from a map within a local scope.
void	setNT(java.lang.String name, boolean value) Sets a boolean variable within a local scope.
void	setNT(java.lang.String name, boolean value, boolean local) Sets a boolean variable.
void	setNT(java.lang.String name, double value) Sets a double variable within a local scope.
void	setNT(java.lang.String name, double value, boolean local) Sets a double variable.
void	setNT(java.lang.String name, float value) Sets a float variable within a local scope.
void	setNT(java.lang.String name, float value, boolean local) Sets a float variable.
void	setNT(java.lang.String name, int value) Sets an int variable within a local scope.
void	setNT(java.lang.String name, int value, boolean local) Sets an int variable.
void	setNT(java.lang.String name, long value) Sets a long variable within a local scope.
void	setNT(java.lang.String name, long value, boolean local) Sets a long variable.
void	setNT(java.lang.String name, java.lang.Object value) Sets a variable in the script context within a local scope.
abstract void	setNT(java.lang.String name, java.lang.Object value, boolean local) Sets a variable, optionally with local scope.
abstract void	setPrecompile(boolean doPrecompile) Sets the pre-compile flag.
abstract void	setSource(java.lang.String source) Sets the source code of this script.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RM_SCRIPT

public static final java.lang.String RM_SCRIPT

A constant string for a return mode of "script".

See Also:

Constant Field Values

RM_RESULT

public static final java.lang.String RM_RESULT

A constant string for a return mode of "result".

See Also:

Constant Field Values

RM_DEFAULT

public static final java.lang.String RM_DEFAULT

A constant string for the default return mode, which is "script".

See Also:

Constant Field Values

SL_BEANSHELL

public static final java.lang.String SL_BEANSHELL

A constant string for the "beanshell" scripting language.

See Also:

Constant Field Values

SL_GROOVY

public static final java.lang.String SL_GROOVY

A constant string for the "groovy" scripting language.

See Also:

Constant Field Values

SL_DEFAULT

public static final java.lang.String SL_DEFAULT

A constant string for the default scripting language, which is "beanshell".

See Also:

Constant Field Values

STR_VALUES_TRUE

public static final java.lang.String[] STR_VALUES_TRUE

An array of strings considered to represent a boolean "true" value.

STR_VALUES_FALSE

public static final java.lang.String[] STR_VALUES_FALSE

An array of strings considered to represent a boolean "false" value.

Constructor Detail

AbstractScript

public AbstractScript()

Method Detail

getInstance

public static AbstractScript getInstance(java.lang.String script,
                                         boolean doPrecompile)

Creates an AbstractScript instance from a string, intelligently detecting whether the string is an XML definition or raw script source.

This factory method first attempts to parse the given string as XML. If parsing is successful, it assumes the string contains a script definition within an XML Element and delegates to the getInstance(Element) method. In this case, the script's return mode is automatically set to "RM_SCRIPT" (Return Mode Script) to return the compiled script object itself.

If XML parsing fails, the method assumes the string is the raw script source directly. It then delegates to an overloaded getInstance method to create a new script instance from this raw source, optionally pre-compiling it.

Parameters:

script - The input string, which can be either an XML script definition or raw script source.

doPrecompile - If true, the script will be pre-compiled during creation.

Returns:

A new AbstractScript instance, either compiled from the XML definition or from the raw source.

getInstance

public static java.lang.Object getInstance(electric.xml.Element el)

Creates an AbstractScript instance from an XML Element.

This method is a factory for creating scripts based on their XML definition. The behavior depends on the value of the "returns" attribute in the Element:

• If "returns" is "RM_SCRIPT", the method returns the compiled script object itself.
• If "returns" is "RM_RESULT", the method executes the script immediately and returns its result.

The method's design is based on the use of scripts in the "KIS" delivery simulation, where rules were defined as Business Objects derived from "JavaImp". This factory method was introduced to handle both returning the script object for later use and immediately returning its execution result.

Parameters:

el - The XML Element that contains the script's definition, including language and return mode attributes.

Returns:

The compiled script object or the result of its execution, depending on the "returns" attribute.

Throws:

java.lang.IllegalArgumentException - If the "returns" attribute has an unknown value.

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile,
                                         java.util.List<ScriptImport> defaultImports)

Creates an AbstractScript instance from various parameters, using default imports.

Parameters:

language - The scripting language to use.

source - The raw script source code.

doPrecompile - If true, the script will be pre-compiled.

defaultImports - A list of default imports to be used by the script.

scriptName - The name of the script.

Returns:

A new AbstractScript instance.

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile,
                                         java.util.List<ScriptImport> defaultImports,
                                         java.lang.String scriptName)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.util.List<ScriptImport> defaultImports)

Creates an AbstractScript instance with only language and default imports.

Parameters:

language - The scripting language to use.

defaultImports - A list of default imports to be used by the script.

Returns:

A new AbstractScript instance.

getInstance

public static AbstractScript getInstance()

Creates an AbstractScript instance with a wide range of configuration options.

Parameters:

language - The scripting language to use. If null, the default is used.

source - The raw script source code.

doPrecompile - If true, the script will be pre-compiled during creation.

parent - The parent script instance, used for variable inheritance.

classLoader - The ClassLoader to use for loading classes.

initialVars - A map of initial variables to be set in the script context.

defaultImports - A list of default imports to be used by the script.

baseClass - The base class to extend, for Groovy scripts.

scriptName - The name of the script, for debugging.

Returns:

A new AbstractScript instance.

Throws:

java.lang.IllegalArgumentException - If the specified language is unknown.

getInstance

public static AbstractScript getInstance(java.lang.String language)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile,
                                         AbstractScript parent)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile,
                                         AbstractScript parent,
                                         java.lang.ClassLoader classLoader)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile,
                                         AbstractScript parent,
                                         java.lang.ClassLoader classLoader,
                                         java.util.Map initialVars)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile,
                                         AbstractScript parent,
                                         java.lang.ClassLoader classLoader,
                                         java.util.Map initialVars,
                                         java.util.List<ScriptImport> defaultImports)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile,
                                         AbstractScript parent,
                                         java.lang.ClassLoader classLoader,
                                         java.util.Map initialVars,
                                         java.util.List<ScriptImport> defaultImports,
                                         java.lang.Class baseClass)

getInstance

public static AbstractScript getInstance(java.lang.String language,
                                         java.lang.String source,
                                         boolean doPrecompile,
                                         AbstractScript parent,
                                         java.lang.ClassLoader classLoader,
                                         java.util.Map initialVars,
                                         java.util.List<ScriptImport> defaultImports,
                                         java.lang.Class baseClass,
                                         java.lang.String scriptName)

getJavaSyntaxImports

public java.lang.String getJavaSyntaxImports(java.util.List imports)

Generates a string of Java import statements from a list of ScriptImport objects.

Parameters:

imports - A list of ScriptImport objects.

aliasAllowed - If true, aliases for imports are included.

Returns:

A string containing the import statements, or an empty string if the list is null or empty.

getJavaSyntaxImports

public java.lang.String getJavaSyntaxImports(java.util.List imports,
                                             boolean aliasAllowed)

getLanguage

public abstract java.lang.String getLanguage()

Returns the scripting language of this script instance.

Returns:

The language as a String (e.g., "beanshell", "groovy").

getSource

public abstract java.lang.String getSource()

Returns the source code of this script.

Returns:

The source code as a String.

setSource

public abstract void setSource(java.lang.String source)

Sets the source code of this script.

Parameters:

source - The new source code as a String.

hasSource

public abstract boolean hasSource()

Checks if this script has source code.

Returns:

true if source code is present, false otherwise.

setLineOffset

public abstract void setLineOffset(int lineOffset)

Sets an offset for line numbers, used for error reporting.

Parameters:

lineOffset - The line offset.

setPrecompile

public abstract void setPrecompile(boolean doPrecompile)

Sets the pre-compile flag.

Parameters:

doPrecompile - The boolean value for the pre-compile flag.

compileNT

public void compileNT()

Compiles the script if it has not been compiled yet.

compileNT

public void compileNT(int lineOffset)

Compiles the script with a specified line offset.

Parameters:

lineOffset - An integer line offset to use for error reporting.

compileNT

public abstract void compileNT(int lineOffset,
                               java.lang.String errorTip)

Compiles the script with a specified line offset and error tip.

Parameters:

lineOffset - An integer line offset to use for error reporting.

errorTip - A string to use as an error message tip if compilation fails.

close

public void close()

Closes this script instance, freeing up resources.

clear

public abstract void clear()

Frees all variables of this script after execution to prevent them from being held "forever" and causing memory leaks.

createFunction

public abstract ScriptFunctionI createFunction(java.lang.String src,
                                               java.lang.String[] parmNames,
                                               java.lang.Class[] parmTypes,
                                               java.lang.Class returnType)

Creates a function from a script source string.

Parameters:

src - The script source code.

parmNames - An array of names for the function's parameters.

parmTypes - An array of Class objects representing the types of the function's parameters.

returnType - The Class object representing the return type of the function.

Returns:

A ScriptFunctionI instance representing the created function.

createFunction

public abstract ScriptFunctionI createFunction(java.lang.String src,
                                               java.lang.String[] parmNames,
                                               java.lang.Class[] parmTypes,
                                               java.lang.Class returnType,
                                               java.lang.String scriptName,
                                               java.lang.String functionName)

Creates a function from a script source string.

Parameters:

src - The script source code.

parmNames - An array of names for the function's parameters.

parmTypes - An array of Class objects representing the types of the function's parameters.

returnType - The Class object representing the return type of the function.

scriptName - The name of the script, used for debugging and error reporting.

functionName - The name of the function.

Returns:

A ScriptFunctionI instance representing the created function.

createFunction

public abstract ScriptFunctionI createFunction(java.lang.String src,
                                               java.lang.String[] parmNames,
                                               java.lang.Class[] parmTypes,
                                               java.lang.Class returnType,
                                               java.lang.String scriptName,
                                               java.lang.String functionName,
                                               int lineOffset)

Creates a function from a script source string.

Parameters:

src - The script source code.

parmNames - An array of names for the function's parameters.

parmTypes - An array of Class objects representing the types of the function's parameters.

returnType - The Class object representing the return type of the function.

scriptName - The name of the script, used for debugging and error reporting.

functionName - The name of the function.

lineOffset - An integer line offset to use for error reporting.

Returns:

A ScriptFunctionI instance representing the created function.

createFunction

public abstract ScriptFunctionI createFunction(java.lang.String src,
                                               java.lang.String[] parmNames,
                                               java.lang.Class[] parmTypes,
                                               java.lang.Class returnType,
                                               java.lang.String scriptName,
                                               java.lang.String functionName,
                                               int lineOffset,
                                               java.lang.Object delegate)

Creates a function from a script source string.

Parameters:

src - The script source code.

parmNames - An array of names for the function's parameters.

parmTypes - An array of Class objects representing the types of the function's parameters.

returnType - The Class object representing the return type of the function.

scriptName - The name of the script, used for debugging and error reporting.

functionName - The name of the function.

lineOffset - An integer line offset to use for error reporting.

delegate - The object to which the function's method calls will be delegated.

Returns:

A ScriptFunctionI instance representing the created function.

runNT

public void runNT()

Runs the script and returns its result as an object.

runNT

public void runNT(int lineOffset)

Runs the script with a specified line offset.

Parameters:

lineOffset - An integer line offset to use for error reporting.

runNT

public void runNT(int lineOffset,
                  java.lang.String errorTip)

Runs the script with a specified line offset and error tip.

Parameters:

lineOffset - An integer line offset to use for error reporting.

errorTip - A string to use as an error message tip if compilation fails.

runAsObjectNT

public java.lang.Object runAsObjectNT()

Runs the script and returns the result as an object, with null as default null value.

Returns:

The result of the script execution as Object.

runAsObjectNT

public java.lang.Object runAsObjectNT(java.lang.Object nullValue)

Runs the script with a specified default null value.

Parameters:

nullValue - The value to return if the script returns null.

Returns:

The result of the script execution as Object or "nullValue" if the script returned null.

runAsObjectNT

public java.lang.Object runAsObjectNT(java.lang.Object nullValue,
                                      int lineOffset)

Runs the script with a specified null value and line offset.

Parameters:

nullValue - The value to return if the script returns null.

lineOffset - An integer line offset to use for error reporting.

Returns:

The result of the script execution as Object or "nullValue" if the script returned null.

runAsObjectNT

public abstract java.lang.Object runAsObjectNT(java.lang.Object nullValue,
                                               int lineOffset,
                                               java.lang.String errorTip)

Runs the script with a specified null value, line offset, and error tip.

Parameters:

nullValue - The value to return if the script returns null.

lineOffset - An integer line offset to use for error reporting.

errorTip - A string to use as an error message tip if compilation fails.

Returns:

The result of the script execution as Object or "nullValue" if the script returned null.

runAsStringNT

public java.lang.String runAsStringNT()

Runs the script and returns the result as a string.

Returns:

The result of the script execution as String.

runAsStringNT

public java.lang.String runAsStringNT(java.lang.String nullValue)

Runs the script and returns the result as a string.

Parameters:

nullValue - The value to return if the script returns null.

Returns:

The result of the script execution as String or "nullValue" if the script returned null.

runAsStringNT

public java.lang.String runAsStringNT(java.lang.String nullValue,
                                      int lineOffset)

Runs the script and returns the result as a string.

Parameters:

nullValue - The value to return if the script returns null.

lineOffset - An integer line offset to use for error reporting.

Returns:

The result of the script execution as String or "nullValue" if the script returned null.

runAsStringNT

public java.lang.String runAsStringNT(java.lang.String nullValue,
                                      int lineOffset,
                                      java.lang.String errorTip)

Runs the script and returns the result as a string.

Parameters:

nullValue - The value to return if the script returns null.

lineOffset - An integer line offset to use for error reporting.

errorTip - A string to use as an error message tip if compilation fails.

Returns:

The result of the script execution as String or "nullValue" if the script returned null.

runAsBoolNT

public boolean runAsBoolNT()

Runs the script and returns the result as a boolean.

Returns:

The result of the script execution as boolean.

runAsBoolNT

public boolean runAsBoolNT(boolean nullValue)

Runs the script and returns the result as a boolean.

Parameters:

nullValue - The value to return if the script returns null.

Returns:

The result of the script execution as boolean or "nullValue" if the script returned null.

runAsBoolNT

public boolean runAsBoolNT(boolean nullValue,
                           int lineOffset)

Runs the script and returns the result as a boolean.

Parameters:

nullValue - The value to return if the script returns null.

lineOffset - An integer line offset to use for error reporting.

Returns:

The result of the script execution as boolean or "nullValue" if the script returned null.

runAsBoolNT

public boolean runAsBoolNT(boolean nullValue,
                           int lineOffset,
                           java.lang.String errorTip)

Runs the script and returns the result as a boolean.

Parameters:

nullValue - The value to return if the script returns null.

lineOffset - An integer line offset to use for error reporting.

errorTip - A string to use as an error message tip if compilation fails.

Returns:

The result of the script execution as boolean or "nullValue" if the script returned null.

setNT

public void setNT(java.lang.String name,
                  java.lang.Object value)

Sets a variable in the script context within a local scope.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

setNT

public abstract void setNT(java.lang.String name,
                           java.lang.Object value,
                           boolean local)

Sets a variable, optionally with local scope.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

local - A flag indicating if the variable shall have a local scope.

setNT

public void setNT(java.lang.String name,
                  long value)

Sets a long variable within a local scope.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

setNT

public void setNT(java.lang.String name,
                  long value,
                  boolean local)

Sets a long variable.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

local - A flag indicating if the variable shall have a local scope.

setNT

public void setNT(java.lang.String name,
                  int value)

Sets an int variable within a local scope.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

setNT

public void setNT(java.lang.String name,
                  int value,
                  boolean local)

Sets an int variable.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

local - A flag indicating if the variable shall have a local scope.

setNT

public void setNT(java.lang.String name,
                  float value)

Sets a float variable within a local scope.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

setNT

public void setNT(java.lang.String name,
                  float value,
                  boolean local)

Sets a float variable.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

local - A flag indicating if the variable shall have a local scope.

setNT

public void setNT(java.lang.String name,
                  double value)

Sets a double variable within a local scope.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

setNT

public void setNT(java.lang.String name,
                  double value,
                  boolean local)

Sets a double variable.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

local - A flag indicating if the variable shall have a local scope.

setNT

public void setNT(java.lang.String name,
                  boolean value)

Sets a boolean variable within a local scope.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

setNT

public void setNT(java.lang.String name,
                  boolean value,
                  boolean local)

Sets a boolean variable.

Parameters:

name - The name of the variable to set.

value - The value of the variable to set.

local - A flag indicating if the variable shall have a local scope.

setNT

public void setNT(java.util.Map map)

Sets variables from a map within a local scope.

Parameters:

map - A map containing key value pairs representing the variable name and values to set.

getNT

public java.lang.Object getNT(java.lang.String name)

Gets the value of a variable from the script context.

Parameters:

name - The name of the variable to retrieve the value of.

Returns:

The value of the variable with the passed name.

getNT

public abstract java.lang.Object getNT(java.lang.String name,
                                       java.lang.Object exValue)

Gets the value of a variable from the script context.

Parameters:

name - The name of the variable to retrieve the value of.

exValue - This parameter is unused in all implementing classes. Maybe it was once intended to be a default value?

Returns:

The value of the variable with the passed name.

evalNT

public java.lang.Object evalNT(java.lang.String source)

Evaluates a string as a script and returns the results as Object.

Parameters:

source - The source of the script to evaluate.

Returns:

The result of the script evaluation as Object.

evalNT

public java.lang.Object evalNT(java.lang.String source,
                               java.lang.Object nullValue)

Evaluates a string as a script with a specified null value and returns the result as Object.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

Returns:

The result of the script evaluation as Object or "nullValue" if the evaluation returned null.

evalNT

public java.lang.Object evalNT(java.lang.String source,
                               java.lang.Object nullValue,
                               int lineOffset)

Evaluates a string as a script with a specified null value and line offset and returns the result as Object.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

lineOffset - An integer line offset to use for error reporting.

Returns:

The result of the script evaluation as Object or "nullValue" if the evaluation returned null.

evalNT

public abstract java.lang.Object evalNT(java.lang.String source,
                                        java.lang.Object nullValue,
                                        int lineOffset,
                                        java.lang.String errorTip)

Evaluates a string as a script with a specified null value and line offset and returns the result as Object.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

lineOffset - An integer line offset to use for error reporting.

errorTip - A string to use as an error message tip if evaluation fails.

Returns:

The result of the script evaluation as Object or "nullValue" if the evaluation returned null.

evalAsStringNT

public java.lang.String evalAsStringNT(java.lang.String source)

Parses the passed script and returns the result as String.

Returns:

The result of the script evaluation as String.

evalAsStringNT

public java.lang.String evalAsStringNT(java.lang.String source,
                                       java.lang.String nullValue)

Evaluates a string as a script with a specified null value and returns the result as String.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

Returns:

The result of the script evaluation as String or "nullValue" if the evaluation returned null.

evalAsStringNT

public java.lang.String evalAsStringNT(java.lang.String source,
                                       java.lang.String nullValue,
                                       int lineOffset)

Evaluates a string as a script with a specified null value and line offset and returns the result as String.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

lineOffset - An integer line offset to use for error reporting.

Returns:

The result of the script evaluation as String or "nullValue" if the evaluation returned null.

evalAsStringNT

public java.lang.String evalAsStringNT(java.lang.String source,
                                       java.lang.String nullValue,
                                       int lineOffset,
                                       java.lang.String errorTip)

Evaluates a string as a script with a specified null value and line offset and returns the result as String.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

lineOffset - An integer line offset to use for error reporting.

errorTip - A string to use as an error message tip if evaluation fails.

Returns:

The result of the script evaluation as String or "nullValue" if the evaluation returned null.

evalAsBoolNT

public boolean evalAsBoolNT(java.lang.String source)

Evaluates a string as a script and returns the result as boolean.

Parameters:

source - The source of the script to evaluate.

Returns:

The result of the script evaluation as boolean or "nullValue" if the evaluation returned null.

evalAsBoolNT

public boolean evalAsBoolNT(java.lang.String source,
                            boolean nullValue)

Evaluates a string as a script with a specified null value and returns the result as boolean.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

Returns:

The result of the script evaluation as boolean or "nullValue" if the evaluation returned null.

evalAsBoolNT

public boolean evalAsBoolNT(java.lang.String source,
                            boolean nullValue,
                            int lineOffset)

Evaluates a string as a script with a specified null value and line offset and returns the result as boolean.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

lineOffset - An integer line offset to use for error reporting.

Returns:

The result of the script evaluation as boolean or "nullValue" if the evaluation returned null.

evalAsBoolNT

public boolean evalAsBoolNT(java.lang.String source,
                            boolean nullValue,
                            int lineOffset,
                            java.lang.String errorTip)

Evaluates a string as a script with a specified null value and line offset and returns the result as boolean.

Parameters:

source - The source of the script to evaluate.

nullValue - The value to return if the evaluation returns null.

lineOffset - An integer line offset to use for error reporting.

errorTip - A string to use as an error message tip if evaluation fails.

Returns:

The result of the script evaluation as boolean or "nullValue" if the evaluation returned null.

asString

public java.lang.String asString(java.lang.Object o,
                                 java.lang.String nullValue)

Converts an object to a string.

Parameters:

o - The Object to convert.

nullValue - The value to return if the passed object is null.

Returns:

The String representation of the passed Object, or "nullValue" if the passed object is null.

asBool

public boolean asBool(java.lang.Object o,
                      boolean nullValue)

Converts an object to a boolean.

Parameters:

o - The Object to convert.

nullValue - The value to return if the passed object is null.

Returns:

The boolean representation of the passed Object, or "nullValue" if the passed object is null.

isScriptException

public static boolean isScriptException(java.lang.Throwable t)

Checks if a Throwable is a script-specific exception.

Parameters:

t - The Throwable to check.

Returns:

true if the throwable is an instance of a known script exception type, false otherwise.

getInterrupt

public java.lang.String getInterrupt()

setInterrupt

public void setInterrupt(java.lang.String $10)