Skip to main content
summaryrefslogtreecommitdiffstats
blob: 9a8bc48aefa890bc55372427f29b4f2dc6f425a8 (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
package org.eclipse.debug.core.model;

/*
 * (c) Copyright IBM Corp. 2000, 2001.
 * All Rights Reserved.
 */

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.core.ILaunch;

/**
 * A debug element represents an artifact in a program being
 * debugged.
 * <p>
 * Some methods on debug elements require communication
 * with the target program. Such methods may throw a <code>DebugException</code>
 * with a status code of <code>TARGET_REQUEST_FAILED</code>
 * when unable to complete a request due to a failure on the target.
 * Methods that require communication with the target program or require
 * the target to be in a specific state (for example, suspended), are declared
 * as such.
 * </p>
 * <p>
 * Debug elements are language independent. However, language specific
 * features can be made available via the adpater mechanism provided by
 * <code>IAdaptable</code>, or by extending the debug element interfaces.
 * A debug model is responsible for declaring any special adapters 
 * its debug elements implement.
 * </p>
 * <p>
 * Clients may implement this interface.
 * </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>
 */
public interface IDebugElement extends IAdaptable {
	
	/**
	 * Debug target type.
	 *
	 * @see IDebugTarget
	 */
	public static final int DEBUG_TARGET= 0x0002;

	/**
	 * Thread type.
	 *
	 * @see IThread
	 */
	public static final int THREAD= 0x0004;

	/**
	 * Stack frame type.
	 *
	 * @see IStackFrame
	 */
	public static final int STACK_FRAME= 0x0008;

	/**
	 * Variable type.
	 *
	 * @see IVariable
	 */
	public static final int VARIABLE= 0x0010;
	
	/**
	 * Value type.
	 *
	 * @see IValue
	 */
	public static final int VALUE= 0x0012;
	
	/**
	 * Returns the type of this element, encoded as an integer - one
	 * of the constants defined in this interface.
	 *
	 * @return debug element type constant
	 */
	int getElementType();
	/**
	 * Returns the unique identifier of the plug-in
	 * this debug element originated from.
	 *
	 * @return plug-in identifier
	 */
	String getModelIdentifier();
	/**
	 * Returns the debug target this element is contained in.
	 * 
	 * @return debug target
	 */
	IDebugTarget getDebugTarget();
	/**
	 * Returns the launch this target is contained in,
	 * or <code>null</code> if not yet registered with
	 * a launch.
	 * 
	 * @return launch or <code>null</code>
	 */
	ILaunch getLaunch();
}


Back to the top