Interface IDebuggerVariable
public interface IDebuggerVariable
A variable managed by a debugger. Variables are generally provided by
IDebuggerThreadStackFrame.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intFinal variable flag.static final intPrivate variable flag.static final intProtected variable flag.static final intPublic variable flag.static final intStatic variable flag. -
Method Summary
Modifier and TypeMethodDescriptionbooleanIndicate if the type can be changed (for variables that have unknown type).booleanIndicate if the value can be changed.format()Return a complete, human-readable representation of the variable.Retrieve the alternate variable name.intgetFlags()Get the variable bit flags.getName()Get the variable name.Retrieve the variable value.booleansetTypedValue(ITypedValue value) Set the variable value.booleansetTypeHint(String typeHint) Set the type hint for this variable.
-
Field Details
-
FLAG_PUBLIC
static final int FLAG_PUBLICPublic variable flag.- See Also:
-
FLAG_PRIVATE
static final int FLAG_PRIVATEPrivate variable flag.- See Also:
-
FLAG_PROTECTED
static final int FLAG_PROTECTEDProtected variable flag.- See Also:
-
FLAG_STATIC
static final int FLAG_STATICStatic variable flag.- See Also:
-
FLAG_FINAL
static final int FLAG_FINALFinal variable flag.- See Also:
-
-
Method Details
-
getName
String getName()Get the variable name.- Returns:
- variable name
-
getAlternateName
String getAlternateName()Retrieve the alternate variable name.- Returns:
- alternate name, or null
-
getFlags
int getFlags()Get the variable bit flags. Refer to theFLAG_xxxconstants in this class.- Returns:
- variable flags
-
canEditValue
boolean canEditValue()Indicate if the value can be changed. UsesetTypedValue(ITypedValue)to modify the value.- Returns:
- true if the value can be changed
-
getTypedValue
ITypedValue getTypedValue()Retrieve the variable value.- Returns:
- the value, null on error
-
setTypedValue
Set the variable value. If the operation is not be permitted or supported, the return value should be false.- Parameters:
value- a value whose type must be consistent with the object provided bygetTypedValue()- Returns:
- true if the value was changed
-
canEditType
boolean canEditType()Indicate if the type can be changed (for variables that have unknown type). UsesetTypeHint(String)to modify the type.- Returns:
- true if the type can be changed
-
setTypeHint
Set the type hint for this variable.- Parameters:
typeHint- type hint- Returns:
- true if the type hint was accepted
-
format
String format()Return a complete, human-readable representation of the variable.- Returns:
- formatted variable
-