blob: d9816397bb560a32351895eaa18cb5aed12c3444 (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.core.model;
import org.eclipse.debug.core.DebugException;
/**
* A value represents the value of a variable.
* A value representing a complex data structure contains variables.
* <p>
* An implementation may choose to re-use or discard
* values on iterative thread suspensions. Clients
* cannot assume that values are identical or equal across
* iterative thread suspensions and must check for equality on iterative
* suspensions if they wish to re-use the objects.
* </p>
* <p>
* An implementation that preserves equality
* across iterative suspensions may display more desirable behavior in
* some clients. For example, if variables are preserved
* while stepping, a UI client would be able to update the UI incrementally,
* rather than collapse and redraw the entire list or tree.
* </p>
* <p>
* Clients may implement this interface.
* </p>
* @see IVariable
*/
public interface IValue extends IDebugElement {
/**
* Returns a description of the type of data this value contains
* or references.
*
* @return the name of this value's reference type
* @exception DebugException if this method fails. Reasons include:
* <ul><li>Failure communicating with the VM. The DebugException's
* status code contains the underlying exception responsible for
* the failure.</li>
*/
String getReferenceTypeName() throws DebugException;
/**
* Returns this value as a <code>String</code>.
*
* @return a String representation of this value
* @exception DebugException if this method fails. Reasons include:
* <ul><li>Failure communicating with the VM. The DebugException's
* status code contains the underlying exception responsible for
* the failure.</li>
*/
String getValueString() throws DebugException;
/**
* Returns whether this value is currently allocated.
* <p>
* For example, if this value represents
* an object that has been garbage collected, <code>false</code> is returned.
* </p>
* @return whether this value is currently allocated
* @exception DebugException if this method fails. Reasons include:
* <ul><li>Failure communicating with the VM. The DebugException's
* status code contains the underlying exception responsible for
* the failure.</li>
*/
boolean isAllocated() throws DebugException;
/**
* Returns the visible variables in this value. An empty
* collection is returned if there are no visible variables.
*
* @return an array of visible variables
* @exception DebugException if this method fails. Reasons include:
* <ul><li>Failure communicating with the VM. The DebugException's
* status code contains the underlying exception responsible for
* the failure.</li>
* </ul>
* @since 2.0
*/
IVariable[] getVariables() throws DebugException;
/**
* Returns whether this value currently contains any visible variables.
*
* @return whether this value currently contains any visible variables
* @exception DebugException if this method fails. Reasons include:
* <ul><li>Failure communicating with the debug target. The DebugException's
* status code contains the underlying exception responsible for
* the failure.</li>
* </ul>
* @since 2.0
*/
boolean hasVariables() throws DebugException;
}
|