org.scripthelper.exceptions

Interface ScriptExceptionListener

All Known Implementing Classes:

AbstractScriptExceptionListener, DefaultExceptionListener, SwingDebugScriptWindow, SwingExceptionListener

public interface ScriptExceptionListener

Fired when the first exception is encountered while executing a script.

Field Summary

Fields

Modifier and Type	Field and Description
static short	STATE_ABORTED The state for aborted scripts.
static short	STATE_ERROR The state for scripts which encountered an error.
static short	STATE_OK The state for scripts for which the execution has performed correctly (or script which have not run yet).

Method Summary

Modifier and Type	Method and Description
void	aborted(java.lang.String message) Fired when an abort is encountered.
default short	getScriptState() Return the state of the listener since the last execution.
void	notified(java.lang.String message, char errorType, java.lang.Throwable th) Fired when any exception is encountered.
void	notifiedFirst(ScriptRuntimeException exception, char errorType, java.lang.String extension) Fired when the first exception is encountered while executing a script.
default void	resetState() Reset the state of the listener.
default void	resetWrapperOnDispose(boolean reset) Set if the associated ScriptWrapper must be resetState when disposing the listener.
void	setScriptLogger(ScriptLogger logger) Set the script logger.

Field Detail

STATE_OK

static final short STATE_OK

The state for scripts for which the execution has performed correctly (or script which have not run yet).

See Also:

Constant Field Values

STATE_ABORTED

static final short STATE_ABORTED

The state for aborted scripts.

See Also:

Constant Field Values

STATE_ERROR

static final short STATE_ERROR

The state for scripts which encountered an error.

See Also:

Constant Field Values

Method Detail

setScriptLogger

void setScriptLogger(ScriptLogger logger)

Set the script logger.

Parameters:

logger - the script logger

aborted

void aborted(java.lang.String message)

Fired when an abort is encountered.

Parameters:

message - the abort message

resetWrapperOnDispose

default void resetWrapperOnDispose(boolean reset)

Set if the associated ScriptWrapper must be resetState when disposing the listener. Do nothing by default.

Parameters:

reset - true if the associated ScriptWrapper must be resetState when disposing the listener

notified

void notified(java.lang.String message,
              char errorType,
              java.lang.Throwable th)

Fired when any exception is encountered.

Parameters:

message - the message

errorType - the error type

th - the Throwable

See Also:

ErrorType

notifiedFirst

void notifiedFirst(ScriptRuntimeException exception,
                   char errorType,
                   java.lang.String extension)

Fired when the first exception is encountered while executing a script.

Parameters:

exception - the ScriptException

errorType - the error type

extension - the language extension

See Also:

ErrorType

getScriptState

default short getScriptState()

Return the state of the listener since the last execution. Return STATE_OK by default.

Returns:

the state of the listener since the last execution

resetState

default void resetState()

Reset the state of the listener.