IDebugBreakPoint.IBreakpointContext Interface

com.bea.ide.debug
IDebugBreakPoint.IBreakpointContext Interface

public static interface IDebugBreakPoint.IBreakpointContext

an interface passed into various breakpoint methods, as a way for the breakpoint to communicate with the target VM.

Enclosing interface

IDebugBreakPoint

Method Summary

public void
clearAllBreakpoints()
clears all the breakpoints the target VM knows about.
public void
clearBreakpoint(String className, int line, int id)
clear the specified breakpoint.
public void
setBreakpoint(String name, int lineNumber, Map properties, int id, String langExt)
sets a breakpoint into the target VM.
public void
setExceptionBreakpoint(String exceptionClass, boolean caught, boolean uncaught, Map properties, int id, String langExt)
sets an exception breakpoint on the target VM.
public void
setMethodBreakpoint(String clazz, String method, String[] params, Map properties, int id, String langExt)
sets a method breakpoint on the target VM.

Method Detail

clearAllBreakpoints() Method

public void clearAllBreakpoints()
throws DebugTransportException
clears all the breakpoints the target VM knows about.

Exceptions

DebugTransportException
-- thrown when this VM cannot communicate with the target VM.

clearBreakpoint(String, int, int) Method

public void clearBreakpoint(String className, 
                            int line, 
                            int id)
throws DebugTransportException
clear the specified breakpoint.

Parameters

className
-- deprecated.
line
-- deprecated.
id
-- the breakpoint ID.

Exceptions

DebugTransportException
-- thrown when this VM cannot communicate with the target VM.

setBreakpoint(String, int, Map, int, String) Method

public void setBreakpoint(String name, 
                          int lineNumber, 
                          Map properties, 
                          int id, 
                          String langExt)
throws DebugTransportException
sets a breakpoint into the target VM.

Parameters

name
-- the class name the breakpoint is on.
lineNumber
-- the line to set the breakpoint on.
properties
-- a map of properties additional to the breakpoint.
id
-- the unique breakpoint ID for this breakpoint.
langExt
-- the extension describing which language the breakpoint is set in. null or an empty string will set a Java breakpoint.

Exceptions

DebugTransportException
-- thrown when this VM cannot communicate with the target VM.

setExceptionBreakpoint(String, boolean, boolean, Map, int, String) Method

public void setExceptionBreakpoint(String exceptionClass, 
                                   boolean caught, 
                                   boolean uncaught, 
                                   Map properties, 
                                   int id, 
                                   String langExt)
throws DebugTransportException
sets an exception breakpoint on the target VM. This will break whenever a breakpoint of this type, or of an extended type is thrown.

Parameters

exceptionClass
-- The exception to catch.
caught
-- true if this should catch exceptions that are ultimately caught by the process.
uncaught
-- true if this should catch exceptions that are uncaught by the process.
properties
-- a map of properties additional to the breakpoint.
id
-- the unique breakpoint ID for this breakpoint.
langExt
-- the extension describing which language the breakpoint is set in. null or an empty string will set a Java breakpoint.

Exceptions

DebugTransportException
-- thrown when this VM cannot communicate with the target VM.

setMethodBreakpoint(String, String, String[], Map, int, String) Method

public void setMethodBreakpoint(String clazz, 
                                String method, 
                                String[] params, 
                                Map properties, 
                                int id, 
                                String langExt)
throws DebugTransportException
sets a method breakpoint on the target VM. This breakpoint will get hit when the method with the specified name is called.

Parameters

clazz
-- the class name the breakpoint is on.
method
-- the method name to set the breakpoint on.
params
-- an array of the parameters of the method to differentiate from overloaded method names. If this is null the breakpoint will be set on the first method with the provided name in the provided class.
properties
-- a map of properties additional to the breakpoint.
id
-- the unique breakpoint ID for this breakpoint.
langExt
-- the extension describing which language the breakpoint is set in. null or an empty string will set a Java breakpoint.

Exceptions

DebugTransportException
-- thrown when this VM cannot communicate with the target VM.