freemarker.debug

Interface Debugger

All Superinterfaces:
Remote

public interface Debugger
extends Remote

The main debugger interface. Allows management of breakpoints as well as installation of listeners for debug events.
Version:
$Id: Debugger.java,v 1.1 2003/05/02 15:55:48 szegedia Exp $
Author:
Attila Szegedi

Field Summary

static int
DEFAULT_PORT

Method Summary

void
addBreakpoint(Breakpoint breakpoint)
Adds a breakpoint
Object
addDebuggerListener(DebuggerListener listener)
Adds a listener for debugger events.
List
getBreakpoints()
Retrieves a list of all Breakpoint objects.
List
getBreakpoints(String templateName)
Retrieves a list of all Breakpoint objects for the specified template.
Collection
getSuspendedEnvironments()
Retrieves a collection of all DebuggedEnvironment objects that are currently suspended.
void
removeBreakpoint(Breakpoint breakpoint)
Removes a single breakpoint
void
removeBreakpoints()
Removes all breakpoints
void
removeBreakpoints(String templateName)
Removes all breakpoints for a specific template
void
removeDebuggerListener(Object id)
Removes a previously added debugger listener.

Field Details

DEFAULT_PORT

public static final int DEFAULT_PORT
Field Value:
7011

Method Details

addBreakpoint

public void addBreakpoint(Breakpoint breakpoint)
            throws RemoteException
Adds a breakpoint
Parameters:
breakpoint - the breakpoint to add

addDebuggerListener

public Object addDebuggerListener(DebuggerListener listener)
            throws RemoteException
Adds a listener for debugger events.
Returns:
an identification token that should be passed to removeDebuggerListener(Object) to remove this listener.

getBreakpoints

public List getBreakpoints()
            throws RemoteException

getBreakpoints

public List getBreakpoints(String templateName)
            throws RemoteException
Retrieves a list of all Breakpoint objects for the specified template.

getSuspendedEnvironments

public Collection getSuspendedEnvironments()
            throws RemoteException
Retrieves a collection of all DebuggedEnvironment objects that are currently suspended.

removeBreakpoint

public void removeBreakpoint(Breakpoint breakpoint)
            throws RemoteException
Removes a single breakpoint
Parameters:
breakpoint - the breakpoint to remove

removeBreakpoints

public void removeBreakpoints()
            throws RemoteException
Removes all breakpoints

removeBreakpoints

public void removeBreakpoints(String templateName)
            throws RemoteException
Removes all breakpoints for a specific template
Parameters:
templateName -

removeDebuggerListener

public void removeDebuggerListener(Object id)
            throws RemoteException
Removes a previously added debugger listener.