org.scripthelper.exceptions

Class ExceptionStack

java.lang.Object

org.scripthelper.exceptions.ExceptionStack

public class ExceptionStack
extends java.lang.Object

Represents the stackTrace for an exception. The ExceptionStack may contain two arrays of StackTracElements if an additional script is created but did not compile. In that case there are two Stack traces:

• The caller stack
• The exception stack when the compilation error is thrown

Since:

1.6.11

Field Summary

Fields

Modifier and Type	Field and Description
static short	STACK_ELEMENT_CALLEE The type for the callee stack.
static short	STACK_ELEMENT_CALLER The type for the caller stack.

Constructor Summary

Constructors

Constructor and Description
ExceptionStack(ScriptWrapper script, ScriptException exception)

Method Summary

Modifier and Type	Method and Description
java.lang.StackTraceElement[]	getCallerStack() Return the caller stack.
short	getCurrentStackElementType() Return the current stack element type.
java.lang.StackTraceElement[]	getExceptionStack() Return the exception stack.
ScriptWrapper	getScript() Return the script wrapper.
java.lang.StackTraceElement	getStackTraceElement(int i) Return the StackTraceElement for an index.
boolean	isCallerStackElementType() Return true if the current stack element type is STACK_ELEMENT_CALLER.
boolean	isExceptionStack(int i) Return true if the exception at an index is in the exception stack.
boolean	isScriptException() Return true if the current StackTraceElement is a script exception.
int	length() Return the length of the stack.

Methods inherited from class java.lang.Object

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

Field Detail

STACK_ELEMENT_CALLER

public static final short STACK_ELEMENT_CALLER

The type for the caller stack. It will be not null only if an additional script is created but did not compile.

See Also:

getCallerStack(), Constant Field Values

STACK_ELEMENT_CALLEE

public static final short STACK_ELEMENT_CALLEE

The type for the callee stack.

See Also:

getExceptionStack(), Constant Field Values

Constructor Detail

ExceptionStack

public ExceptionStack(ScriptWrapper script,
                      ScriptException exception)

Method Detail

getScript

public ScriptWrapper getScript()

Return the script wrapper.

Returns:

the script wrapper

getCallerStack

public java.lang.StackTraceElement[] getCallerStack()

Return the caller stack. It will be not null only if an additional script is created but did not compile. In that case there are two Stack traces:

• The caller stack
• The exception stack when the compilation error is thrown

Returns:

the caller stack

getExceptionStack

public java.lang.StackTraceElement[] getExceptionStack()

Return the exception stack.

Returns:

the exception stack

length

public int length()

Return the length of the stack. It is the addition of the caller stack (if it is not null) and the ecetion stack.

Returns:

the length of the stack

getCurrentStackElementType

public short getCurrentStackElementType()

Return the current stack element type.

Returns:

the current stack element type

isCallerStackElementType

public boolean isCallerStackElementType()

Return true if the current stack element type is STACK_ELEMENT_CALLER.

Returns:

the current stack element type is STACK_ELEMENT_CALLER

isScriptException

public boolean isScriptException()

Return true if the current StackTraceElement is a script exception.

Returns:

true if the current StackTraceElement is a script exception

getStackTraceElement

public java.lang.StackTraceElement getStackTraceElement(int i)

Return the StackTraceElement for an index. Deending on if getCallerStack() is null or not, it can be an element of the caller stack or an element of the exception stack.

Parameters:

i - the index

Returns:

the StackTraceElement

isExceptionStack

public boolean isExceptionStack(int i)

Return true if the exception at an index is in the exception stack.

Parameters:

i - the StackTraceElement index

Returns:

true if the exception at the index is in the exception stack