org.scripthelper.model

Class AbstractDebuggingScriptWrapper<S>

java.lang.Object

org.scripthelper.model.AbstractScriptWrapper<S>

org.scripthelper.model.AbstractDebuggingScriptWrapper<S>

Type Parameters:

S - the script interface

All Implemented Interfaces:

DebuggingWrapper<S>, ScriptMethodInvoker, ScriptWrapper<S>

Direct Known Subclasses:

GroovyScriptWrapper

public abstract class AbstractDebuggingScriptWrapper<S>
extends AbstractScriptWrapper<S>
implements DebuggingWrapper<S>

An abstract debugging sxript xrapper implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected DebugListener	debugListener The debug listener.
protected DebuggingWrapper<?>	parentWrapper The parent wrapper.
protected DebugSession<S>	session The debug session.

Fields inherited from class org.scripthelper.model.AbstractScriptWrapper

additionalHelpers, context, exListeners, firstException, hasCustomHelper, helper, importLines, logger, offset, optimLevel, scriptContent, source, VARIABLES_DECL_AFTER_CLASS_DECL, VARIABLES_DECL_BEFORE_CLASS_DECL

Fields inherited from interface org.scripthelper.model.ScriptWrapper

MODE_BLOCKING, MODE_NON_BLOCKING, OPTIM_LEVEL_DEFAULT, OPTIM_LEVEL_MAX, OPTIM_LEVEL_MIN

Constructor Summary

Constructors

Constructor and Description
AbstractDebuggingScriptWrapper()
AbstractDebuggingScriptWrapper(DebuggingWrapper<?> parentWrapper)

Method Summary

Modifier and Type	Method and Description
void	__step__(java.lang.Object... args) Fired when entering a debug step.
DebugSession<S>	createDebugSession() Create a debug session.
void	endDebugSession() End a debug session.
void	err(java.lang.String message, char errorType, java.lang.Throwable e) Log an error.
DebugListener	getDebugListener() Return the debug listener.
DebugSession<S>	getDebugSession() Return the current Debug session.
int	getLineNumber(ScriptSource source, int lineNumber) Return the effective line number of a line detected in the script runtime.
int	getLineNumber(ScriptSource source, int lineNumber, boolean isException) Return the effective line number of a line detected in the script runtime.
DebuggingWrapper<?>	getParentWrapper() Return the parent Script wrapper.
protected ScriptLogger	getPreferredLogger() Return the preferred logger.
void	initializeDebugSession() Initialize a debug session.
boolean	isDebugging() Return true if the wrapper is in a debug session and debugging.
boolean	isInDebugSession() Return true if the wrapper is in a debug session.
void	setDebugListener(DebugListener debugListener) Set the debug listener.

Methods inherited from class org.scripthelper.model.AbstractScriptWrapper

abort, addActiveScript, addAdditionalHelper, addExceptionListener, addImports, addImports, addImports, addUncompiledScript, clearActiveScriptFiles, clearAdditionalHelpers, clearImports, convertPrimitiveArgument, countImportLines, createScriptContext, createScriptObject, createScriptObject, getActiveEncodedScriptFile, getActiveScriptFile, getActiveScripts, getActiveScriptSource, getAdditionalHelpers, getAdditionalScriptContent, getClassLoader, getCompileException, getCompileException, getContextClassPath, getCustomImports, getDefaultContent, getDefaultDeclaration, getDefaultImports, getEnd, getExceptionListeners, getExecutionMode, getFilename, getHelperClassPath, getInvocableMethodKey, getLoggerClassPath, getOffset, getOptimizationLevel, getRawScript, getRuntimeException, getRuntimeException, getScriptClassName, getScriptContent, getScriptContext, getScriptFile, getScriptInterface, getScriptProxy, getSingletonMethod, getSource, getVariablesDeclarationsPosition, hasActiveScriptFile, hasAdditionalHelpers, hasScriptHelper, hasSingletonMethod, installScript, installScript, installScript, installScript, isLoggingExceptions, logExceptions, notifyExceptionToListeners, parseScript, reInstallScript, reInstallScript, reInstallScript, removeExceptionListener, removeTabulations, setClassLoader, setExecutionMode, setOptimizationLevel, setScriptContext, setScriptLogger, startMethod

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scripthelper.model.DebuggingWrapper

isDebugSupported

Methods inherited from interface org.scripthelper.model.ScriptWrapper

abort, abort, addAdditionalHelper, addExceptionListener, addImports, addImports, addImports, clearAdditionalHelpers, clearImports, countImportLines, createAdditionalScript, createAdditionalScript, err, getActiveEncodedScriptFile, getActiveScriptFile, getActiveScripts, getActiveScriptSource, getAdditionalHelpers, getClassLoader, getExceptionListeners, getExecutionMode, getFilename, getMIME, getOffset, getOptimizationLevel, getRawScript, getScript, getScriptClassName, getScriptContent, getScriptContext, getScriptException, getScriptExtension, getScriptFile, getScriptInterface, getScriptProxy, getScriptProxy, getScriptProxyHandler, getSource, hasActiveScriptFile, hasAdditionalHelpers, hasScriptHelper, hasSingletonMethod, installScript, installScript, installScript, installScript, installScript, installScript, installScript, installScript, isLibAvailable, isLibAvailable, isLoggingExceptions, isMultiImplementSupported, isSingletonMethodEnabled, logExceptions, reInstallScript, removeExceptionListener, resetWrapperState, setClassLoader, setExecutionMode, setOptimizationLevel, setScriptContext, setScriptLogger, startMethod

Methods inherited from interface org.scripthelper.model.ScriptMethodInvoker

cacheInvocableMethods, getInvocableMethods, getInvocableMethodsByNames, hasInvocableMethod, invokeMethod, invokeMethod, isAutoCachingInvocableMethods, isInvocableByName, isInvocableMethodsEnabled, setAutoCacheInvocableMethods

Field Detail

debugListener

protected DebugListener debugListener

The debug listener.

session

protected DebugSession<S> session

The debug session.

parentWrapper

protected DebuggingWrapper<?> parentWrapper

The parent wrapper.

Constructor Detail

AbstractDebuggingScriptWrapper

public AbstractDebuggingScriptWrapper()

AbstractDebuggingScriptWrapper

public AbstractDebuggingScriptWrapper(DebuggingWrapper<?> parentWrapper)

Method Detail

getParentWrapper

public DebuggingWrapper<?> getParentWrapper()

Return the parent Script wrapper.

Specified by:

getParentWrapper in interface DebuggingWrapper<S>

Returns:

the parent Script wrapper

initializeDebugSession

public void initializeDebugSession()

Initialize a debug session.

Specified by:

initializeDebugSession in interface DebuggingWrapper<S>

endDebugSession

public void endDebugSession()

End a debug session.

Specified by:

endDebugSession in interface DebuggingWrapper<S>

createDebugSession

public DebugSession<S> createDebugSession()
                                   throws java.lang.Exception

Create a debug session. This method must be overriden to effectively create the session. Note that this method calles initializeDebugSession().

Specified by:

createDebugSession in interface DebuggingWrapper<S>

Returns:

null by default

Throws:

java.lang.Exception

getDebugSession

public DebugSession<S> getDebugSession()

Return the current Debug session.

Specified by:

getDebugSession in interface DebuggingWrapper<S>

Returns:

the current Debug session

setDebugListener

public void setDebugListener(DebugListener debugListener)

Set the debug listener.

Specified by:

setDebugListener in interface DebuggingWrapper<S>

Parameters:

debugListener - the debug listener

getDebugListener

public DebugListener getDebugListener()

Return the debug listener.

Specified by:

getDebugListener in interface DebuggingWrapper<S>

Returns:

listener the debug listener

__step__

public void __step__(java.lang.Object... args)

Fired when entering a debug step.

Specified by:

__step__ in interface ScriptWrapper<S>

Parameters:

args - the arguments

isDebugging

public boolean isDebugging()

Return true if the wrapper is in a debug session and debugging.

Specified by:

isDebugging in interface ScriptWrapper<S>

Returns:

false by default

isInDebugSession

public boolean isInDebugSession()

Return true if the wrapper is in a debug session.

Specified by:

isInDebugSession in interface ScriptWrapper<S>

Returns:

true if the wrapper is in a debug session

getPreferredLogger

protected ScriptLogger getPreferredLogger()

Return the preferred logger. Return the logger by default.

Overrides:

getPreferredLogger in class AbstractScriptWrapper<S>

Returns:

the preferred logger

err

public void err(java.lang.String message,
                char errorType,
                java.lang.Throwable e)

Log an error.

Specified by:

err in interface ScriptWrapper<S>

Overrides:

err in class AbstractScriptWrapper<S>

Parameters:

message - the error message

errorType - the error type

e - the Throwable

See Also:

ErrorType

getLineNumber

public int getLineNumber(ScriptSource source,
                         int lineNumber)

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

Specified by:

getLineNumber in interface ScriptWrapper<S>

Overrides:

getLineNumber in class AbstractScriptWrapper<S>

Parameters:

lineNumber - the line number

source - the script source

Returns:

the effective line number

getLineNumber

public int getLineNumber(ScriptSource source,
                         int lineNumber,
                         boolean isException)

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

Specified by:

getLineNumber in interface ScriptWrapper<S>

Parameters:

lineNumber - the line number

isException - true for getting the line number for an exception

source - the script source

Returns:

the effective line number