Package org.eclipse.debug.core
Interface IBreakpointManager
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
- See Also:
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddBreakpoint(IBreakpoint breakpoint) Adds the given breakpoint to the collection of registered breakpoints in the workspace and notifies all registered listeners.voidaddBreakpointListener(IBreakpointListener listener) Adds the given listener to the collection of registered breakpoint listeners.voidaddBreakpointListener(IBreakpointsListener listener) Adds the given listener to the collection of registered breakpoint listeners.voidAdds the given listener to the collection of registered breakpoint manager listeners.voidaddBreakpoints(IBreakpoint[] breakpoints) Adds the given breakpoints to the collection of registered breakpoints in the workspace and notifies all registered listeners.voidaddTriggerPoint(IBreakpoint breakpoint) Adds the given breakpoint as the triggering breakpoint in the workspace and notifies all registered listeners.voidenableTriggerPoints(IBreakpoint[] triggerPoints, boolean enable) Revisit all the trigger points to activate/deactivate trigger points.voidfireBreakpointChanged(IBreakpoint breakpoint) Notifies all registered listeners that the given breakpoint has changed.getBreakpoint(IMarker marker) Returns the breakpoint associated with the given marker ornullif no such breakpoint existsReturns a collection of all registered breakpoints.getBreakpoints(String modelIdentifier) Returns a collection of all breakpoints registered for the given debug model.getImportParticipants(String markertype) Returns an array ofIBreakpointImportParticipants for the given breakpoint marker id, nevernull.Returns the triggers for the breakpoints associated with the workspace ornullif no such breakpoint existsgetTypeName(IBreakpoint breakpoint) Returns the name (user readable String) of the given breakpoint's type ornullif none has been specified.booleanReturns whether a workspace has active TriggerPointsbooleanReturns whether there are any registered breakpoints.booleanReturns whether or not this breakpoint manager is enabled.booleanisRegistered(IBreakpoint breakpoint) Returns whether the given breakpoint is currently registered with this breakpoint manager.voidTouch and refresh the display of all breakpoints.voidRemoves all the trigger points from the breakpoint manager.voidremoveBreakpoint(IBreakpoint breakpoint, boolean delete) Removes the given breakpoint from the breakpoint manager, deletes the marker associated with the breakpoint if thedeleteflag istrue, and notifies all registered listeners.voidremoveBreakpointListener(IBreakpointListener listener) Removes the given listener from the collection of registered breakpoint listeners.voidremoveBreakpointListener(IBreakpointsListener listener) Removes the given listener from the collection of registered breakpoint listeners.voidRemoves the given listener from the collection of registered breakpoint manager listeners.voidremoveBreakpoints(IBreakpoint[] breakpoints, boolean delete) Removes the given breakpoints from the breakpoint manager, deletes the markers associated with the breakpoints if thedeleteflag istrue, and notifies all registered listeners.voidremoveTriggerPoint(IBreakpoint breakpoint) Removes the given breakpoint as the trigger breakpoint in the workspace and notifies all registered listeners.voidsetEnabled(boolean enabled) Sets the enabled state of this breakpoint manager.
-
Method Details
-
addBreakpoint
Adds the given breakpoint to the collection of registered breakpoints in the workspace and notifies all registered listeners. This has no effect if the given breakpoint is already registered.- Parameters:
breakpoint- the breakpoint to add- Throws:
CoreException- if adding fails. Reasons include:- CONFIGURATION_INVALID - the required
MODEL_IDENTIFIERattribute is not set on the breakpoint marker. - A
CoreExceptionoccurred while verifying theMODEL_IDENTIFIERattribute.
- CONFIGURATION_INVALID - the required
- Since:
- 2.0
-
addBreakpoints
Adds the given breakpoints to the collection of registered breakpoints in the workspace and notifies all registered listeners. Has no effect on breakpoints that are already registered.- Parameters:
breakpoints- the breakpoints to add- Throws:
CoreException- if adding fails. Reasons include:- CONFIGURATION_INVALID - the required
MODEL_IDENTIFIERattribute is not set on a breakpoint marker. - A
CoreExceptionoccurred while verifying aMODEL_IDENTIFIERattribute.
- CONFIGURATION_INVALID - the required
- Since:
- 2.1
-
getBreakpoint
Returns the breakpoint associated with the given marker ornullif no such breakpoint exists- Parameters:
marker- the marker- Returns:
- the breakpoint associated with the marker
or
nullif none exists - Since:
- 2.0
-
getBreakpoints
IBreakpoint[] getBreakpoints()Returns a collection of all registered breakpoints. Returns an empty array if no breakpoints are registered.- Returns:
- an array of breakpoints
- Since:
- 2.0
-
hasBreakpoints
boolean hasBreakpoints()Returns whether there are any registered breakpoints.- Returns:
- whether there are any registered breakpoints
- Since:
- 2.0
-
getBreakpoints
Returns a collection of all breakpoints registered for the given debug model. Answers an empty array if no breakpoints are registered for the given debug model.- Parameters:
modelIdentifier- identifier of a debug model plug-in- Returns:
- an array of breakpoints
- Since:
- 2.0
-
isRegistered
Returns whether the given breakpoint is currently registered with this breakpoint manager.- Parameters:
breakpoint- a breakpoint- Returns:
- whether the breakpoint is registered
- Since:
- 2.0
-
fireBreakpointChanged
Notifies all registered listeners that the given breakpoint has changed. Has no effect if the given breakpoint is not currently registered. This method is intended to be used when a breakpoint attribute is changed that does not alter the breakpoint's underlying marker, that is, when notification will not occur via the marker delta mechanism.- Parameters:
breakpoint- the breakpoint that has changed.- Since:
- 2.0
-
removeBreakpoint
Removes the given breakpoint from the breakpoint manager, deletes the marker associated with the breakpoint if thedeleteflag istrue, and notifies all registered listeners. Has no effect if the given breakpoint is not currently registered.- Parameters:
breakpoint- the breakpoint to removedelete- whether to delete the marker associated with the breakpoint- Throws:
CoreException- if an exception occurs while deleting the underlying marker.- Since:
- 2.0
-
removeBreakpoints
Removes the given breakpoints from the breakpoint manager, deletes the markers associated with the breakpoints if thedeleteflag istrue, and notifies all registered listeners. Has no effect on breakpoints not currently registered.- Parameters:
breakpoints- the breakpoints to removedelete- whether to delete the markers associated with the breakpoints- Throws:
CoreException- if an exception occurs while deleting an underlying marker.- Since:
- 2.1
-
addBreakpointListener
Adds the given listener to the collection of registered breakpoint listeners. Has no effect if an identical listener is already registered.- Parameters:
listener- the listener to add
-
removeBreakpointListener
Removes the given listener from the collection of registered breakpoint listeners. Has no effect if an identical listener is not already registered.- Parameters:
listener- the listener to remove
-
addBreakpointListener
Adds the given listener to the collection of registered breakpoint listeners. Has no effect if an identical listener is already registered.- Parameters:
listener- the listener to add- Since:
- 2.1
-
removeBreakpointListener
Removes the given listener from the collection of registered breakpoint listeners. Has no effect if an identical listener is not already registered.- Parameters:
listener- the listener to remove- Since:
- 2.1
-
addBreakpointManagerListener
Adds the given listener to the collection of registered breakpoint manager listeners. Has no effect if an identical listener is already registered.- Parameters:
listener- the listener to add- Since:
- 3.0
-
removeBreakpointManagerListener
Removes the given listener from the collection of registered breakpoint manager listeners. Has no effect if an identical listener is not already registered.- Parameters:
listener- the listener to remove- Since:
- 3.0
-
isEnabled
boolean isEnabled()Returns whether or not this breakpoint manager is enabled. When a breakpoint manager is enabled, all breakpoints should be honored. When it is disabled, breakpoints should not be honored, regardless of each breakpoint's enabled state.- Returns:
- whether or not this breakpoint manager is enabled
- Since:
- 3.0
-
setEnabled
void setEnabled(boolean enabled) Sets the enabled state of this breakpoint manager. When enabled, breakpoints should be honoured. When disabled, all breakpoints should be ignored.- Parameters:
enabled- whether this breakpoint manager should be enabled- Since:
- 3.0
-
getTypeName
Returns the name (user readable String) of the given breakpoint's type ornullif none has been specified.- Parameters:
breakpoint- the breakpoint- Returns:
- the name of the given breakpoint's type or
null - Since:
- 3.1
-
getImportParticipants
Returns an array ofIBreakpointImportParticipants for the given breakpoint marker id, nevernull.- Parameters:
markertype- theStringidentifier of the marker type- Returns:
- an array of
IBreakpointImportParticipants for the given marker type, nevernull - Throws:
CoreException- if an exception occurs- Since:
- 3.5
-
getTriggerPoints
IBreakpoint[] getTriggerPoints()Returns the triggers for the breakpoints associated with the workspace ornullif no such breakpoint exists- Returns:
- the triggers breakpoint associated with the workspace or
nullif none exists - Since:
- 3.11
-
addTriggerPoint
Adds the given breakpoint as the triggering breakpoint in the workspace and notifies all registered listeners.- Parameters:
breakpoint- the breakpoint to be added as the trigger point- Throws:
CoreException- if adding fails. Reasons include:- CONFIGURATION_INVALID - the required
MODEL_IDENTIFIERattribute is not set on the breakpoint marker. - A
CoreExceptionoccurred while verifying theMODEL_IDENTIFIERattribute.
- CONFIGURATION_INVALID - the required
- Since:
- 3.11
-
removeTriggerPoint
Removes the given breakpoint as the trigger breakpoint in the workspace and notifies all registered listeners.- Parameters:
breakpoint- the breakpoint to be removed as the trigger point- Throws:
CoreException- if adding fails. Reasons include:- CONFIGURATION_INVALID - the required
MODEL_IDENTIFIERattribute is not set on the breakpoint marker. - A
CoreExceptionoccurred while verifying theMODEL_IDENTIFIERattribute.
- CONFIGURATION_INVALID - the required
- Since:
- 3.11
-
removeAllTriggerPoints
Removes all the trigger points from the breakpoint manager.- Throws:
CoreException- if an exception occurs while deleting an underlying marker.- Since:
- 3.11
-
hasActiveTriggerPoints
boolean hasActiveTriggerPoints()Returns whether a workspace has active TriggerPoints- Returns:
- return
trueif a breakpoint has active triggers and cannot suspend and returnfalseotherwise. - Since:
- 3.11
-
enableTriggerPoints
Revisit all the trigger points to activate/deactivate trigger points.- Parameters:
triggerPoints- list of trigger points to be deactivated ornullto deactivate all trigger pointsenable- enable iftrueor disable iffalse- Since:
- 3.11
-
refreshTriggerpointDisplay
void refreshTriggerpointDisplay()Touch and refresh the display of all breakpoints.- Since:
- 3.11
-