|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IBreakpointManager
The breakpoint manager manages the collection of breakpoints in the workspace. A breakpoint suspends the execution of a program being debugged. The kinds of breakpoints supported by each debug architecture and the information required to create those breakpoints is defined by each debug architecture. Breakpoint creation is a client responsibility.
Clients interested in breakpoint change notification may
register with the breakpoint manager - see
IBreakpointListener
and IBreakpointsListener
This interface is not intended to be implemented by clients.
IBreakpointListener
,
IBreakpointsListener
Method Summary | |
---|---|
void |
addBreakpoint(IBreakpoint breakpoint)
Adds the given breakpoint to the collection of registered breakpoints in the workspace and notifies all registered listeners. |
void |
addBreakpointListener(IBreakpointListener listener)
Adds the given listener to the collection of registered breakpoint listeners. |
void |
addBreakpointListener(IBreakpointsListener listener)
Adds the given listener to the collection of registered breakpoint listeners. |
void |
addBreakpointManagerListener(IBreakpointManagerListener listener)
Adds the given listener to the collection of registered breakpoint manager listeners. |
void |
addBreakpoints(IBreakpoint[] breakpoints)
Adds the given breakpoints to the collection of registered breakpoints in the workspace and notifies all registered listeners. |
void |
fireBreakpointChanged(IBreakpoint breakpoint)
Notifies all registered listeners that the given breakpoint has changed. |
IBreakpoint |
getBreakpoint(IMarker marker)
Returns the breakpoint associated with the given marker or null if no such breakpoint exists |
IBreakpoint[] |
getBreakpoints()
Returns a collection of all registered breakpoints. |
IBreakpoint[] |
getBreakpoints(java.lang.String modelIdentifier)
Returns a collection of all breakpoints registered for the given debug model. |
java.lang.String |
getTypeName(IBreakpoint breakpoint)
Returns the name (user readable String) of the given breakpoint's type or null if none has been
specified. |
boolean |
hasBreakpoints()
Returns whether there are any registered breakpoints. |
boolean |
isEnabled()
Returns whether or not this breakpoint manager is enabled. |
boolean |
isRegistered(IBreakpoint breakpoint)
Returns whether the given breakpoint is currently registered with this breakpoint manager. |
void |
removeBreakpoint(IBreakpoint breakpoint,
boolean delete)
Removes the given breakpoint from the breakpoint manager, deletes the marker associated with the breakpoint if the delete flag
is true , and notifies all registered
listeners. |
void |
removeBreakpointListener(IBreakpointListener listener)
Removes the given listener from the collection of registered breakpoint listeners. |
void |
removeBreakpointListener(IBreakpointsListener listener)
Removes the given listener from the collection of registered breakpoint listeners. |
void |
removeBreakpointManagerListener(IBreakpointManagerListener listener)
Removes the given listener from the collection of registered breakpoint manager listeners. |
void |
removeBreakpoints(IBreakpoint[] breakpoints,
boolean delete)
Removes the given breakpoints from the breakpoint manager, deletes the markers associated with the breakpoints if the delete flag
is true , and notifies all registered
listeners. |
void |
setEnabled(boolean enabled)
Sets the enabled state of this breakpoint manager. |
Method Detail |
---|
void addBreakpoint(IBreakpoint breakpoint) throws CoreException
breakpoint
- the breakpoint to add
DebugException
- if adding fails. Reasons include:MODEL_IDENTIFIER
attribute
is not set on the breakpoint marker.CoreException
occurred while verifying the MODEL_IDENTIFIER
attribute.CoreException
void addBreakpoints(IBreakpoint[] breakpoints) throws CoreException
breakpoints
- the breakpoints to add
DebugException
- if adding fails. Reasons include:MODEL_IDENTIFIER
attribute
is not set on a breakpoint marker.CoreException
occurred while verifying a MODEL_IDENTIFIER
attribute.CoreException
IBreakpoint getBreakpoint(IMarker marker)
null
if no such breakpoint exists
marker
- the marker
null
if none existsIBreakpoint[] getBreakpoints()
boolean hasBreakpoints()
IBreakpoint[] getBreakpoints(java.lang.String modelIdentifier)
modelIdentifier
- identifier of a debug model plug-in
boolean isRegistered(IBreakpoint breakpoint)
void fireBreakpointChanged(IBreakpoint breakpoint)
breakpoint
- the breakpoint that has changed.void removeBreakpoint(IBreakpoint breakpoint, boolean delete) throws CoreException
delete
flag
is true
, and notifies all registered
listeners. Has no effect if the given breakpoint is not currently
registered.
breakpoint
- the breakpoint to removedelete
- whether to delete the marker associated with the
breakpoint
CoreException
- if an exception occurs while deleting the
underlying marker.void removeBreakpoints(IBreakpoint[] breakpoints, boolean delete) throws CoreException
delete
flag
is true
, and notifies all registered
listeners. Has no effect on breakpoints not currently
registered.
breakpoints
- the breakpoints to removedelete
- whether to delete the markers associated with the
breakpoints
CoreException
- if an exception occurs while deleting an
underlying marker.void addBreakpointListener(IBreakpointListener listener)
listener
- the listener to addvoid removeBreakpointListener(IBreakpointListener listener)
listener
- the listener to removevoid addBreakpointListener(IBreakpointsListener listener)
listener
- the listener to addvoid removeBreakpointListener(IBreakpointsListener listener)
listener
- the listener to removevoid addBreakpointManagerListener(IBreakpointManagerListener listener)
listener
- the listener to addvoid removeBreakpointManagerListener(IBreakpointManagerListener listener)
listener
- the listener to removeboolean isEnabled()
void setEnabled(boolean enabled)
enabled
- whether this breakpoint manager should be
enabledjava.lang.String getTypeName(IBreakpoint breakpoint)
null
if none has been
specified.
breakpoint
- the breakpoint
null
|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.