blob: be82c07760ebc887d1cba761c2f8b507b093a74b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
package org.eclipse.debug.core;
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved.
*/
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.runtime.CoreException;
/**
* The breakpoint manager manages the collection of breakpoints
* in the workspace. A breakpoint suspends the execution of a
* program being debugged. The kinds of breakpoint supported by each
* debug architecture and the information required to create those
* breakpoints is dictated by each debug architecture.
*
* <p>
* Breakpoint creation is a client responsibility. Breakpoints
* are only considered active when registered with the breakpoint manager.
* </p>
* <p>
* As launches are registered and deregistered, the breakpoint
* manager automatically adds and removes debug targets associated with those
* lauches, as breakpoint listeners.
* Debug targets (implementors of <code>IBreakpointSupport</code>) are
* informed of breakpoint additions, removals, and changes if they
* respond <code>true</code> to <code>supportsBreakpoints()</code>.
* A debug target is responsible for installing all existing
* (applicable) breakpoints when created.
* </p>
* <p>
* This interface is not intended to be implemented by clients.
* </p>
* <p>
* <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
* change significantly before reaching stability. It is being made available at this early stage to solicit feedback
* from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
* (repeatedly) as the API evolves.
* </p>
* @see org.eclipse.debug.core.model.IBreakpointSupport
*/
public interface IBreakpointManager {
/**
* Adds the given breakpoint to the collection of active breakpoints
* in the workspace and notifies all registered listeners. This has no effect
* if the given breakpoint is already registered.
*
* @param breakpoint the breakpoint to add
*
* @exception DebugException if adding fails. Reasons include:<ul>
* <li>CONFIGURATION_INVALID - the required <code>MODEL_IDENTIFIER</code> attribute
* is not set on the breakpoint marker.</li>
* <li>A <code>CoreException</code> occurred while verifying the <code>MODEL_IDENTIFIER</code>
* attribute.</li>
* </ul>
*/
void addBreakpoint(IBreakpoint breakpoint) throws DebugException;
/**
* Returns the breakpoint that is associated with marker or
* <code>null</code> if no such breakpoint exists
*
* @param marker the marker
* @return the breakpoint associated with the marker or null if none exists
*/
IBreakpoint getBreakpoint(IMarker marker);
/**
* Returns a collection of all existing breakpoints.
* Returns an empty array if no breakpoints exist.
*
* @return an array of breakpoints
*/
IBreakpoint[] 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.
*
* @param modelIdentifier identifier of a debug model plug-in
* @return an array of breakpoints
*/
IBreakpoint[] getBreakpoints(String modelIdentifier);
/**
* Returns a collection of all existing markers.
* Returns an empty array if no markers exist.
*
* @return an array of breakpoint markers
*/
IMarker[] getMarkers();
/**
* Returns a collection of all markers registered for the
* given debug model. Answers an empty array if no markers are registered
* for the given debug model.
*
* @param modelIdentifier identifier of a debug model plug-in
* @return an array of breakpoint markers
*/
IMarker[] getMarkers(String modelIdentifier);
/**
* Returns whether the given breakpoint is currently
* registered with this breakpoint manager.
*
* @return whether the breakpoint is registered
*/
boolean isRegistered(IBreakpoint breakpoint);
/**
* Removes the given breakpoint from the breakpoint manager, and notifies all
* registered listeners. The breakpoint is deleted if the <code>delete</code> flag is
* true. Has no effect if the given breakpoint is not currently registered.
*
* @param breakpoint the breakpoint to remove
* @param delete whether the breakpoint should be deleted
* @exception CoreException if an exception occurs while deleting the breakpoint.
*/
void removeBreakpoint(IBreakpoint breakpoint, boolean delete) throws CoreException;
/**
* Removes the breakpoint associated with the given marker from the breakpoint manager, and notifies all
* registered listeners. The marker is deleted if the <code>delete</code> flag is
* true. Has no effect if the given breakpoint is not currently registered.
*
* @param marker the marker to remove
* @param delete whether the breakpoint marker should be deleted
* @exception CoreException if an exception occurs while deleting the marker.
*/
void removeMarker(IMarker marker, boolean delete) throws CoreException;
/**
* Adds the given listener to the collection of registered breakpoint listeners.
* Has no effect if an identical listener is already registered.
*
* @param listener the listener to add
*/
void addBreakpointListener(IBreakpointListener listener);
/**
* Removes the given listener from the collection of registered breakpoint listeners.
* Has no effect if an identical listener is not already registered.
*
* @param listener the listener to remove
*/
void removeBreakpointListener(IBreakpointListener listener);
}
|
