org.scripthelper.debug

Class DebugSession<S>

java.lang.Object

org.scripthelper.debug.DebugSession<S>

Type Parameters:

S - the script interface

All Implemented Interfaces:

LineNumberConverter

public class DebugSession<S>
extends java.lang.Object
implements LineNumberConverter

Represents a Debug session.

Field Summary

Fields

Modifier and Type	Field and Description
static short	STATE_CONTINUE The continue state.
static short	STATE_STEP The step state.

Constructor Summary

Constructors

Constructor and Description
DebugSession(DebuggingWrapper<S> wrapper, SourceModel model)
DebugSession(DebugSession<?> parentSession, DebuggingWrapper<S> wrapper, SourceModel model)

Method Summary

Modifier and Type	Method and Description
Step	addBreakpoint(int lineNumber) Add a breakpoint for a line number, or change the breakpoint to a step.
void	addStep(Step step) Add a step.
void	continueScript() Continue the script.
void	endSession() End a debug session.
DebugListener	getDebugListener() Return the debug listener.
DebugSourceModel	getDebugSourceModel() Return the debug source model.
short	getExecutionMode() Return the execution mode.
int	getLineNumber(int lineNumber, boolean isException) Return the effective line number of a line detected in the script runtime.
DebugSession<?>	getParentSession() Return the parent session.
S	getScript() Return the script.
ScriptProxy<S>	getScriptProxy() Return the script proxy.
ScriptWrapper<S>	getScriptWrapper() Return the script wrapper.
SessionHook<S>	getSessionHook() Return the session hook.
SourceModel	getSourceModel() Return the source model.
short	getState() Return the session state.
java.util.SortedMap<java.lang.Integer,Step>	getSteps() Return the steps.
boolean	hasBreakpoint(int lineNumber) Return true if there is a breakpoint on a specified line number.
boolean	hasParentSession() Return true if there is a parent session.
boolean	hasStep(int lineNumber) Return true if there is a step on a specified line number.
boolean	isDebugging() Return true if the debugger is currently in a debug session.
void	setDebugListener(DebugListener debugListener) Set the debug listener.
void	setDebugSourceModel(DebugSourceModel debugModel) Set the debug source model.
void	setExecutionMode(short mode) Set the execution mode.
void	setScriptProxy(ScriptProxy<S> scriptProxy) Set the ScriptProxy.
void	setSessionHook(SessionHook<S> hook) Set the session hook.
void	setState(short state) Set the session state.
java.lang.Object	startScript() This method must be called when starting the script.
java.lang.Object	startScript(java.lang.Object... args) This method must be called when starting the script.
void	startSession() Start a debug session.
void	step(java.lang.Object... args) Fired when entering a debug step.

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.LineNumberConverter

getLineNumber

Field Detail

STATE_CONTINUE

public static final short STATE_CONTINUE

The continue state.

See Also:

Constant Field Values

STATE_STEP

public static final short STATE_STEP

The step state.

See Also:

Constant Field Values

Constructor Detail

DebugSession

public DebugSession(DebuggingWrapper<S> wrapper,
                    SourceModel model)

DebugSession

public DebugSession(DebugSession<?> parentSession,
                    DebuggingWrapper<S> wrapper,
                    SourceModel model)

Method Detail

setScriptProxy

public void setScriptProxy(ScriptProxy<S> scriptProxy)

Set the ScriptProxy.

Parameters:

scriptProxy - the ScriptProxy

setExecutionMode

public void setExecutionMode(short mode)

Set the execution mode.

Parameters:

mode - the execution mode

getExecutionMode

public short getExecutionMode()

Return the execution mode.

Returns:

the execution mode

setDebugListener

public void setDebugListener(DebugListener debugListener)

Set the debug listener.

Parameters:

debugListener - the listener

getDebugListener

public DebugListener getDebugListener()

Return the debug listener.

Returns:

listener the debug listener

setSessionHook

public void setSessionHook(SessionHook<S> hook)

Set the session hook.

Parameters:

hook - the session hook

getSessionHook

public SessionHook<S> getSessionHook()

Return the session hook.

Returns:

the session hook

getState

public short getState()

Return the session state.

Returns:

the state

startScript

public java.lang.Object startScript()

This method must be called when starting the script. Defer to startScript(java.lang.Object...) with an empty arguments array.

Returns:

the script result

startScript

public java.lang.Object startScript(java.lang.Object... args)

This method must be called when starting the script.

Parameters:

args - the arguments

Returns:

the script result

startSession

public void startSession()

Start a debug session.

endSession

public void endSession()

End a debug session.

isDebugging

public boolean isDebugging()

Return true if the debugger is currently in a debug session.

Returns:

true if the debugger is currently in a debug session

getScript

public S getScript()

Return the script.

Returns:

the script

getScriptProxy

public ScriptProxy<S> getScriptProxy()

Return the script proxy.

Returns:

the script proxy

getSourceModel

public SourceModel getSourceModel()

Return the source model.

Returns:

the source model

setDebugSourceModel

public void setDebugSourceModel(DebugSourceModel debugModel)

Set the debug source model.

Parameters:

debugModel - the debug source model

getDebugSourceModel

public DebugSourceModel getDebugSourceModel()

Return the debug source model.

Returns:

the debug source model

getParentSession

public DebugSession<?> getParentSession()

Return the parent session.

Returns:

the parent session

hasParentSession

public boolean hasParentSession()

Return true if there is a parent session.

Returns:

true if there is a parent session

getScriptWrapper

public ScriptWrapper<S> getScriptWrapper()

Return the script wrapper.

Returns:

the script wrapper

addStep

public void addStep(Step step)

Add a step.

Parameters:

step - the step

getLineNumber

public int getLineNumber(int lineNumber,
                         boolean isException)

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

Specified by:

getLineNumber in interface LineNumberConverter

Parameters:

lineNumber - the line number

isException - true for getting the line nulmber for an exception

Returns:

the effective line number

getSteps

public java.util.SortedMap<java.lang.Integer,Step> getSteps()

Return the steps.

Returns:

the steps

hasStep

public boolean hasStep(int lineNumber)

Return true if there is a step on a specified line number.

Parameters:

lineNumber - the line number

Returns:

true if there is a step on the specified line number

hasBreakpoint

public boolean hasBreakpoint(int lineNumber)

Return true if there is a breakpoint on a specified line number.

Parameters:

lineNumber - the line number

Returns:

true if there is a breakpoint on the specified line number

addBreakpoint

public Step addBreakpoint(int lineNumber)

Add a breakpoint for a line number, or change the breakpoint to a step.

Parameters:

lineNumber - the line number

Returns:

the breakpoint if the breakpoint was added, or the step if it was already a breakpoint, or null if there is no step on the line

continueScript

public void continueScript()

Continue the script.

setState

public void setState(short state)

Set the session state.

Parameters:

state - the state

step

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

Fired when entering a debug step.

Parameters:

args - the arguments