Package freemarker.debug
Interface Debugger
-
- All Superinterfaces:
java.rmi.Remote
public interface Debugger extends java.rmi.Remote
The main debugger interface. Allows management of breakpoints as well as installation of listeners for debug events.
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_PORT
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addBreakpoint(Breakpoint breakpoint)
Adds a breakpointjava.lang.Object
addDebuggerListener(DebuggerListener listener)
Adds a listener for debugger events.java.util.List
getBreakpoints()
Retrieves a list of allBreakpoint
objects.java.util.List
getBreakpoints(java.lang.String templateName)
Retrieves a list of allBreakpoint
objects for the specified template.java.util.Collection
getSuspendedEnvironments()
Retrieves a collection of allDebuggedEnvironment
objects that are currently suspended.void
removeBreakpoint(Breakpoint breakpoint)
Removes a single breakpointvoid
removeBreakpoints()
Removes all breakpointsvoid
removeBreakpoints(java.lang.String templateName)
Removes all breakpoints for a specific templatevoid
removeDebuggerListener(java.lang.Object id)
Removes a previously added debugger listener.
-
-
-
Field Detail
-
DEFAULT_PORT
static final int DEFAULT_PORT
- See Also:
- Constant Field Values
-
-
Method Detail
-
addBreakpoint
void addBreakpoint(Breakpoint breakpoint) throws java.rmi.RemoteException
Adds a breakpoint- Parameters:
breakpoint
- the breakpoint to add- Throws:
java.rmi.RemoteException
-
removeBreakpoint
void removeBreakpoint(Breakpoint breakpoint) throws java.rmi.RemoteException
Removes a single breakpoint- Parameters:
breakpoint
- the breakpoint to remove- Throws:
java.rmi.RemoteException
-
removeBreakpoints
void removeBreakpoints(java.lang.String templateName) throws java.rmi.RemoteException
Removes all breakpoints for a specific template- Throws:
java.rmi.RemoteException
-
removeBreakpoints
void removeBreakpoints() throws java.rmi.RemoteException
Removes all breakpoints- Throws:
java.rmi.RemoteException
-
getBreakpoints
java.util.List getBreakpoints() throws java.rmi.RemoteException
Retrieves a list of allBreakpoint
objects.- Throws:
java.rmi.RemoteException
-
getBreakpoints
java.util.List getBreakpoints(java.lang.String templateName) throws java.rmi.RemoteException
Retrieves a list of allBreakpoint
objects for the specified template.- Throws:
java.rmi.RemoteException
-
getSuspendedEnvironments
java.util.Collection getSuspendedEnvironments() throws java.rmi.RemoteException
Retrieves a collection of allDebuggedEnvironment
objects that are currently suspended.- Throws:
java.rmi.RemoteException
-
addDebuggerListener
java.lang.Object addDebuggerListener(DebuggerListener listener) throws java.rmi.RemoteException
Adds a listener for debugger events.- Returns:
- an identification token that should be passed to
removeDebuggerListener(Object)
to remove this listener. - Throws:
java.rmi.RemoteException
-
removeDebuggerListener
void removeDebuggerListener(java.lang.Object id) throws java.rmi.RemoteException
Removes a previously added debugger listener.- Parameters:
id
- the identification token for the listener that was returned from a prior call toaddDebuggerListener(DebuggerListener)
.- Throws:
java.rmi.RemoteException
-
-