de.ipcon.tools

Class BeanShellScript

java.lang.Object

de.ipcon.tools.AbstractScript

de.ipcon.tools.BeanShellScript

public class BeanShellScript
extends AbstractScript

Field Summary

Fields inherited from class de.ipcon.tools.AbstractScript

RM_DEFAULT, RM_RESULT, RM_SCRIPT, SL_BEANSHELL, SL_DEFAULT, SL_GROOVY, STR_VALUES_FALSE, STR_VALUES_TRUE

Constructor Summary

Constructors

Constructor and Description
BeanShellScript(java.lang.String _src)
BeanShellScript(java.lang.String _src, boolean _precompile)
BeanShellScript(java.lang.String _src, boolean _precompile, BeanShellScript _parent)
BeanShellScript(java.lang.String _src, boolean _precompile, BeanShellScript _parent, java.lang.ClassLoader _classloader)
BeanShellScript(java.lang.String _src, boolean _precompile, BeanShellScript _parent, java.lang.ClassLoader _classloader, java.util.Map _initialvars)
BeanShellScript(java.lang.String _src, boolean _precompile, BeanShellScript _parent, java.lang.ClassLoader _classloader, java.util.Map _initialvars, java.util.List<ScriptImport> _defaultImports)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	boolConverter(java.lang.Object o, java.lang.Object nullValue)
boolean	checkNS()
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	compile() macht die Syntax-Ueberpruefung
void	compileNT(int _lineOffset, java.lang.String errorTip) macht die Syntax-Ueberpruefung aber NoThrow
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.
ScriptFunctionI	createFunction(java.lang.String _src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String _sn)
ScriptFunctionI	createFunction(java.lang.String _src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String _sn, java.lang.String _fn) Creates a function from a script source string.
ScriptFunctionI	createFunction(java.lang.String _src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String _sn, java.lang.String _fn, int _lineOffset) Creates a function from a script source string.
ScriptFunctionI	createFunction(java.lang.String _src, java.lang.String[] parmNames, java.lang.Class[] parmTypes, java.lang.Class returnType, java.lang.String _sn, java.lang.String _fn, int _lineOffset, java.lang.Object _delegate) Creates a function from a script source string.
boolean	evalAsBoolNT(java.lang.String s, 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.Object	evalNT(java.lang.String s, 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.
java.lang.Object	evalNT(java.lang.String s, java.lang.Object nullValue, int _lineOffset, java.lang.String errorTip, java.util.function.BiFunction typeConverter)
java.util.Map	getAllVarMap()
java.lang.Object	getAsyncRc()
java.lang.String	getImports()
bsh.Interpreter	getInterpreter()
java.lang.String	getLanguage() Returns the scripting language of this script instance.
int	getLineOffset()
java.lang.String	getMname()
bsh.NameSpace	getNs()
java.lang.String	getNSName()
java.lang.Object	getNT(java.lang.String s, java.lang.Object exValue) Gets the value of a variable from the script context.
BeanShellScript	getParent()
java.lang.String	getSource() Returns the source code of this script.
java.lang.String	getSrc()
boolean	hasSource() Checks if this script has source code.
boolean	isCompiled()
boolean	isPrecompile()
boolean	isSource(java.lang.String s)
static void	main(java.lang.String[] args)
void	run()
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.
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.
void	runNT() FIXME: lineOffset = wenn das BeanShellScript im Kontext eines grossen Skripts laeuft, kann man mittels des Offsets die "Startzeile" des aktuellen Skripts mitgeben
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	setAsyncRc(java.lang.Object $22)
void	setCompiled(boolean $20)
void	setImports(java.lang.String $16)
void	setInterpreter(bsh.Interpreter $14)
void	setLineOffset(int $18) Sets an offset for line numbers, used for error reporting.
void	setMname(java.lang.String $19)
void	setNs(bsh.NameSpace $23)
void	setNT(java.lang.String s, java.lang.Object value, boolean local) Sets a variable, optionally with local scope.
void	setParent(BeanShellScript $15)
void	setPrecompile(boolean $21) Sets the pre-compile flag.
void	setSource(java.lang.String _src) Sets the source code of this script.
void	setSrc(java.lang.String $17)

Methods inherited from class de.ipcon.tools.AbstractScript

asBool, asString, compileNT, compileNT, evalAsBoolNT, evalAsBoolNT, evalAsBoolNT, evalAsStringNT, evalAsStringNT, evalAsStringNT, evalAsStringNT, evalNT, evalNT, evalNT, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getInterrupt, getJavaSyntaxImports, getJavaSyntaxImports, getNT, isScriptException, runAsBoolNT, runAsBoolNT, runAsBoolNT, runAsBoolNT, runAsStringNT, runAsStringNT, runAsStringNT, runAsStringNT, setInterrupt, setNT, setNT, setNT, setNT, setNT, setNT, setNT, setNT, setNT, setNT, setNT, setNT

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanShellScript

public BeanShellScript(java.lang.String _src)

BeanShellScript

public BeanShellScript(java.lang.String _src,
                       boolean _precompile)

BeanShellScript

public BeanShellScript(java.lang.String _src,
                       boolean _precompile,
                       BeanShellScript _parent)

BeanShellScript

public BeanShellScript(java.lang.String _src,
                       boolean _precompile,
                       BeanShellScript _parent,
                       java.lang.ClassLoader _classloader)

BeanShellScript

public BeanShellScript(java.lang.String _src,
                       boolean _precompile,
                       BeanShellScript _parent,
                       java.lang.ClassLoader _classloader,
                       java.util.Map _initialvars)

BeanShellScript

public BeanShellScript(java.lang.String _src,
                       boolean _precompile,
                       BeanShellScript _parent,
                       java.lang.ClassLoader _classloader,
                       java.util.Map _initialvars,
                       java.util.List<ScriptImport> _defaultImports)

Method Detail

getLanguage

public java.lang.String getLanguage()

Description copied from class: AbstractScript

Returns the scripting language of this script instance.

Specified by:

getLanguage in class AbstractScript

Returns:

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

getNSName

public java.lang.String getNSName()

getSource

public java.lang.String getSource()

Description copied from class: AbstractScript

Returns the source code of this script.

Specified by:

getSource in class AbstractScript

Returns:

The source code as a String.

setSource

public void setSource(java.lang.String _src)

Description copied from class: AbstractScript

Sets the source code of this script.

Specified by:

setSource in class AbstractScript

Parameters:

_src - The new source code as a String.

close

public void close()

Description copied from class: AbstractScript

Closes this script instance, freeing up resources.

Overrides:

close in class AbstractScript

clear

public void clear()

Description copied from class: AbstractScript

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

Specified by:

clear in class AbstractScript

createFunction

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

Description copied from class: AbstractScript

Creates a function from a script source string.

Specified by:

createFunction in class AbstractScript

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 ScriptFunctionI createFunction(java.lang.String _src,
                                      java.lang.String[] parmNames,
                                      java.lang.Class[] parmTypes,
                                      java.lang.Class returnType,
                                      java.lang.String _sn)

createFunction

public ScriptFunctionI createFunction(java.lang.String _src,
                                      java.lang.String[] parmNames,
                                      java.lang.Class[] parmTypes,
                                      java.lang.Class returnType,
                                      java.lang.String _sn,
                                      java.lang.String _fn)

Description copied from class: AbstractScript

Creates a function from a script source string.

Specified by:

createFunction in class AbstractScript

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.

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

_fn - The name of the function.

Returns:

A ScriptFunctionI instance representing the created function.

createFunction

public ScriptFunctionI createFunction(java.lang.String _src,
                                      java.lang.String[] parmNames,
                                      java.lang.Class[] parmTypes,
                                      java.lang.Class returnType,
                                      java.lang.String _sn,
                                      java.lang.String _fn,
                                      int _lineOffset)

Description copied from class: AbstractScript

Creates a function from a script source string.

Specified by:

createFunction in class AbstractScript

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.

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

_fn - 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 ScriptFunctionI createFunction(java.lang.String _src,
                                      java.lang.String[] parmNames,
                                      java.lang.Class[] parmTypes,
                                      java.lang.Class returnType,
                                      java.lang.String _sn,
                                      java.lang.String _fn,
                                      int _lineOffset,
                                      java.lang.Object _delegate)

Description copied from class: AbstractScript

Creates a function from a script source string.

Specified by:

createFunction in class AbstractScript

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.

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

_fn - 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.

getAllVarMap

public java.util.Map getAllVarMap()

run

public void run()
         throws bsh.EvalError

Throws:

bsh.EvalError

isSource

public boolean isSource(java.lang.String s)

hasSource

public boolean hasSource()

Description copied from class: AbstractScript

Checks if this script has source code.

Specified by:

hasSource in class AbstractScript

Returns:

true if source code is present, false otherwise.

runNT

public void runNT()

FIXME: lineOffset = wenn das BeanShellScript im Kontext eines grossen Skripts laeuft, kann man mittels des Offsets die "Startzeile" des aktuellen Skripts mitgeben

Overrides:

runNT in class AbstractScript

runNT

public void runNT(int _lineOffset)

Description copied from class: AbstractScript

Runs the script with a specified line offset.

Overrides:

runNT in class AbstractScript

Parameters:

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

runNT

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

Description copied from class: AbstractScript

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

Overrides:

runNT in class AbstractScript

Parameters:

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

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

compile

public void compile()
             throws bsh.EvalError

macht die Syntax-Ueberpruefung

Throws:

bsh.EvalError

compileNT

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

macht die Syntax-Ueberpruefung aber NoThrow

Specified by:

compileNT in class AbstractScript

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()

Description copied from class: AbstractScript

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

Overrides:

runAsObjectNT in class AbstractScript

Returns:

The result of the script execution as Object.

runAsObjectNT

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

Description copied from class: AbstractScript

Runs the script with a specified default null value.

Overrides:

runAsObjectNT in class AbstractScript

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)

Description copied from class: AbstractScript

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

Overrides:

runAsObjectNT in class AbstractScript

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 java.lang.Object runAsObjectNT(java.lang.Object nullValue,
                                      int _lineOffset,
                                      java.lang.String errorTip)

Description copied from class: AbstractScript

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

Specified by:

runAsObjectNT in class AbstractScript

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.

checkNS

public boolean checkNS()

setNT

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

Description copied from class: AbstractScript

Sets a variable, optionally with local scope.

Specified by:

setNT in class AbstractScript

Parameters:

s - 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.

getNT

public java.lang.Object getNT(java.lang.String s,
                              java.lang.Object exValue)

Description copied from class: AbstractScript

Gets the value of a variable from the script context.

Specified by:

getNT in class AbstractScript

Parameters:

s - 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 s,
                               java.lang.Object nullValue,
                               int _lineOffset,
                               java.lang.String errorTip)

Description copied from class: AbstractScript

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

Specified by:

evalNT in class AbstractScript

Parameters:

s - 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.

evalNT

public java.lang.Object evalNT(java.lang.String s,
                               java.lang.Object nullValue,
                               int _lineOffset,
                               java.lang.String errorTip,
                               java.util.function.BiFunction typeConverter)

evalAsBoolNT

public boolean evalAsBoolNT(java.lang.String s,
                            boolean nullValue,
                            int _lineOffset,
                            java.lang.String errorTip)

Description copied from class: AbstractScript

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

Overrides:

evalAsBoolNT in class AbstractScript

Parameters:

s - 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.

boolConverter

public java.lang.Object boolConverter(java.lang.Object o,
                                      java.lang.Object nullValue)

main

public static void main(java.lang.String[] args)

getInterpreter

public bsh.Interpreter getInterpreter()

setInterpreter

public void setInterpreter(bsh.Interpreter $14)

getParent

public BeanShellScript getParent()

setParent

public void setParent(BeanShellScript $15)

getImports

public java.lang.String getImports()

setImports

public void setImports(java.lang.String $16)

getSrc

public java.lang.String getSrc()

setSrc

public void setSrc(java.lang.String $17)

getLineOffset

public int getLineOffset()

setLineOffset

public void setLineOffset(int $18)

Description copied from class: AbstractScript

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

Specified by:

setLineOffset in class AbstractScript

Parameters:

$18 - The line offset.

getMname

public java.lang.String getMname()

setMname

public void setMname(java.lang.String $19)

isCompiled

public boolean isCompiled()

setCompiled

public void setCompiled(boolean $20)

isPrecompile

public boolean isPrecompile()

setPrecompile

public void setPrecompile(boolean $21)

Description copied from class: AbstractScript

Sets the pre-compile flag.

Specified by:

setPrecompile in class AbstractScript

Parameters:

$21 - The boolean value for the pre-compile flag.

getAsyncRc

public java.lang.Object getAsyncRc()

setAsyncRc

public void setAsyncRc(java.lang.Object $22)

getNs

public bsh.NameSpace getNs()

setNs

public void setNs(bsh.NameSpace $23)