org.scripthelper.exceptions

Class AbstractScriptException<S>

java.lang.Object

org.scripthelper.exceptions.AbstractScriptException<S>

Type Parameters:

S - the script interface

All Implemented Interfaces:

ScriptException<S>

Direct Known Subclasses:

GroovyScriptException, JSScriptException, PythonScriptException, RubyScriptException

public abstract class AbstractScriptException<S>
extends java.lang.Object
implements ScriptException<S>

This interface wraps an exception fired by the Scripting engine.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	message The exception message.
protected ScriptWrapper<S>	script The script wrapper.
protected java.util.List<java.lang.StackTraceElement>	stackTrace The StackTrace.

Fields inherited from interface org.scripthelper.exceptions.ScriptException

COMPILATION_EXCEPTION, RUNTIME_EXCEPTION

Constructor Summary

Constructors

Constructor and Description
AbstractScriptException(ScriptWrapper<S> script, short exceptionType, java.lang.Throwable throwable, java.lang.String message, int lineNumber) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addToStrackTrace(int line, java.lang.String fileName, java.lang.StackTraceElement st) Add a StackTraceElement to the StackTrace
short	getExceptionType() Return the exception type.
java.lang.String	getFilename() Return the script filename.
int	getLineNumber() Return the exception line number.
int	getLineNumber(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.
protected abstract void	populateStackTrace(boolean filterScriptExceptions) Populate the StackTrace.
void	setFileName(java.lang.String filename) Set the exception file name.
void	setScript(ScriptWrapper<S> script) Set the script wrapper.

Methods inherited from class java.lang.Object

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

Field Detail

script

protected ScriptWrapper<S> script

The script wrapper.

message

protected java.lang.String message

The exception message.

stackTrace

protected java.util.List<java.lang.StackTraceElement> stackTrace

The StackTrace.

Constructor Detail

AbstractScriptException

public AbstractScriptException(ScriptWrapper<S> script,
                               short exceptionType,
                               java.lang.Throwable throwable,
                               java.lang.String message,
                               int lineNumber)

Constructor.

Parameters:

script -

exceptionType -

throwable -

message -

lineNumber -

Method Detail

setFileName

public void setFileName(java.lang.String filename)

Set the exception file name.

Parameters:

filename - the file name

getExceptionType

public short getExceptionType()

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

Specified by:

getExceptionType in interface ScriptException<S>

Returns:

the exception type

addToStrackTrace

protected void addToStrackTrace(int line,
                                java.lang.String fileName,
                                java.lang.StackTraceElement st)

Add a StackTraceElement to the StackTrace

Parameters:

line - the line number

fileName - the Script file name

st - the wrapped StackTraceElement

getStackTrace

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

Return the StackTrace.

Specified by:

getStackTrace in interface ScriptException<S>

Parameters:

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

Returns:

the StackTrace

getSource

public ScriptSource getSource()

Return the script source.

Specified by:

getSource in interface ScriptException<S>

Returns:

the script source

getFilename

public java.lang.String getFilename()

Return the script filename.

Specified by:

getFilename in interface ScriptException<S>

Returns:

the script filename

getLineNumber

public int getLineNumber(int lineNumber)

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

Specified by:

getLineNumber in interface ScriptException<S>

Parameters:

lineNumber - the line number

Returns:

the effective line number

getLineNumber

public int getLineNumber()

Return the exception line number.

Specified by:

getLineNumber in interface ScriptException<S>

Returns:

the exception line number

setScript

public void setScript(ScriptWrapper<S> script)

Set the script wrapper.

Specified by:

setScript in interface ScriptException<S>

Parameters:

script - the script wrapper

getScript

public ScriptWrapper<S> getScript()

Return the script wrapper.

Specified by:

getScript in interface ScriptException<S>

Returns:

the script wrapper

getMessage

public java.lang.String getMessage()

Return the exception message.

Specified by:

getMessage in interface ScriptException<S>

Returns:

the exception message

getThrowable

public java.lang.Throwable getThrowable()

Return the wrapped Java exception.

Specified by:

getThrowable in interface ScriptException<S>

Returns:

the wrapped Java exception

populateStackTrace

protected abstract void populateStackTrace(boolean filterScriptExceptions)

Populate the StackTrace.

Parameters:

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