org.scripthelper.exceptions

Interface ScriptException<S>

Type Parameters:

S - the script interface

All Known Implementing Classes:

AbstractScriptException, GroovyScriptException, JSScriptException, PythonScriptException, RubyScriptException

public interface ScriptException<S>

This interface wraps an exception fired by the Scripting engine.

Field Summary

Fields

Modifier and Type	Field and Description
static short	COMPILATION_EXCEPTION Compilation exceptions.
static short	RUNTIME_EXCEPTION Runtime exceptions.

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	getCallerThrowable() Return the throwable whch have been created from the caller script.
short	getExceptionType() Return the exception type.
java.io.File	getFile() Return the script file.
java.lang.String	getFilename() Return the script filename.
int	getLineNumber() Return the exception line number.
int	getLineNumber(ScriptSource source, int lineNumber) Return the effective line number of a line detected in the script runtime.
java.lang.String	getMessage() Return the exception message.
ScriptWrapper<S>	getScript() Return the script wrapper.
ScriptSource	getSource() Return the script source.
java.util.List<java.lang.StackTraceElement>	getStackTrace(boolean filterScriptExceptions) Return the StackTrace.
java.lang.Throwable	getThrowable() Return the wrapped Java exception.
boolean	isScriptException(java.lang.StackTraceElement st) Return true if a StackTraceElement is a script exception.
void	setFile(java.io.File file) Set the exception file.
void	setScript(ScriptWrapper<S> script) Set the script wrapper.
void	setupExceptionOrigin() Setup the exception origin.

Field Detail

COMPILATION_EXCEPTION

static final short COMPILATION_EXCEPTION

Compilation exceptions.

See Also:

Constant Field Values

RUNTIME_EXCEPTION

static final short RUNTIME_EXCEPTION

Runtime exceptions.

See Also:

Constant Field Values

Method Detail

setupExceptionOrigin

void setupExceptionOrigin()

Setup the exception origin. It should set:

• The File: see getFile()
• The file name: see getFilename()
• The line number: see getLineNumber()

getExceptionType

short getExceptionType()

Return the exception type. It can be a RUNTIME_EXCEPTION or COMPILATION_EXCEPTION.

Returns:

the exception type

setScript

void setScript(ScriptWrapper<S> script)

Set the script wrapper.

Parameters:

script - the script wrapper

getScript

ScriptWrapper<S> getScript()

Return the script wrapper.

Returns:

the script wrapper

getSource

ScriptSource getSource()

Return the script source.

Returns:

the script source

getFilename

java.lang.String getFilename()

Return the script filename.

Returns:

the script filename

isScriptException

boolean isScriptException(java.lang.StackTraceElement st)

Return true if a StackTraceElement is a script exception.

Parameters:

st - the StackTraceElement

Returns:

true if the StackTraceElement is a script exception

getFile

java.io.File getFile()

Return the script file.

Returns:

the script file

setFile

void setFile(java.io.File file)

Set the exception file.

Parameters:

file - the file

getCallerThrowable

java.lang.Throwable getCallerThrowable()

Return the throwable whch have been created from the caller script. It will only be null for an additional script.

Returns:

the throwable

getLineNumber

int getLineNumber(ScriptSource source,
                  int lineNumber)

Return the effective line number of a line detected in the script runtime.

Parameters:

source - the script source

lineNumber - the line number

Returns:

the effective line number

getLineNumber

int getLineNumber()

Return the exception line number.

Returns:

the exception line number

getMessage

java.lang.String getMessage()

Return the exception message.

Returns:

the exception message

getThrowable

java.lang.Throwable getThrowable()

Return the wrapped Java exception.

Returns:

the wrapped Java exception

getStackTrace

java.util.List<java.lang.StackTraceElement> getStackTrace(boolean filterScriptExceptions)

Return the StackTrace.

Parameters:

filterScriptExceptions - filter the script exceptions, if true only those exceptions will be added in the StackTrace

Returns:

the StackTrace