public class Variable
extends java.lang.Object
Optionally a variable can have a 'type' that is shown if space permits or when hovering over the variable's name.
An optional 'kind' is used to render additional properties of the variable, e.g. different icons can be used to indicate that a variable is public or private.
If the value is structured (has children), a handle is provided to retrieve the children with the VariablesRequest.
If the number of named or indexed children is large, the numbers should be returned via the optional 'namedVariables' and 'indexedVariables' attributes.
The client can use this optional information to present the children in a paged UI and fetch them in chunks.
Constructor and Description |
---|
Variable() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getEvaluateName()
Optional evaluatable name of this variable which can be passed to the 'EvaluateRequest' to fetch the variable's
value.
|
java.lang.Integer |
getIndexedVariables()
The number of indexed child variables.
|
java.lang.String |
getMemoryReference()
Optional memory reference for the variable if the variable represents executable code, such as a function
pointer.
|
java.lang.String |
getName()
The variable's name.
|
java.lang.Integer |
getNamedVariables()
The number of named child variables.
|
VariablePresentationHint |
getPresentationHint()
Properties of a variable that can be used to determine how to render the variable in the UI.
|
java.lang.String |
getType()
The type of the variable's value.
|
java.lang.String |
getValue()
The variable's value.
|
int |
getVariablesReference()
If variablesReference is > 0, the variable is structured and its children can be retrieved by passing
variablesReference to the VariablesRequest.
|
int |
hashCode() |
void |
setEvaluateName(java.lang.String evaluateName)
Optional evaluatable name of this variable which can be passed to the 'EvaluateRequest' to fetch the variable's
value.
|
void |
setIndexedVariables(java.lang.Integer indexedVariables)
The number of indexed child variables.
|
void |
setMemoryReference(java.lang.String memoryReference)
Optional memory reference for the variable if the variable represents executable code, such as a function
pointer.
|
void |
setName(java.lang.String name)
The variable's name.
|
void |
setNamedVariables(java.lang.Integer namedVariables)
The number of named child variables.
|
void |
setPresentationHint(VariablePresentationHint presentationHint)
Properties of a variable that can be used to determine how to render the variable in the UI.
|
void |
setType(java.lang.String type)
The type of the variable's value.
|
void |
setValue(java.lang.String value)
The variable's value.
|
void |
setVariablesReference(int variablesReference)
If variablesReference is > 0, the variable is structured and its children can be retrieved by passing
variablesReference to the VariablesRequest.
|
java.lang.String |
toString() |
@Pure public java.lang.String getName()
public void setName(java.lang.String name)
@Pure public java.lang.String getValue()
public void setValue(java.lang.String value)
@Pure public java.lang.String getType()
This attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request.
This is an optional property.
public void setType(java.lang.String type)
This attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request.
This is an optional property.
@Pure public VariablePresentationHint getPresentationHint()
This is an optional property.
public void setPresentationHint(VariablePresentationHint presentationHint)
This is an optional property.
@Pure public java.lang.String getEvaluateName()
This is an optional property.
public void setEvaluateName(java.lang.String evaluateName)
This is an optional property.
@Pure public int getVariablesReference()
public void setVariablesReference(int variablesReference)
@Pure public java.lang.Integer getNamedVariables()
The client can use this optional information to present the children in a paged UI and fetch them in chunks.
This is an optional property.
public void setNamedVariables(java.lang.Integer namedVariables)
The client can use this optional information to present the children in a paged UI and fetch them in chunks.
This is an optional property.
@Pure public java.lang.Integer getIndexedVariables()
The client can use this optional information to present the children in a paged UI and fetch them in chunks.
This is an optional property.
public void setIndexedVariables(java.lang.Integer indexedVariables)
The client can use this optional information to present the children in a paged UI and fetch them in chunks.
This is an optional property.
@Pure public java.lang.String getMemoryReference()
This attribute is only required if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request.
This is an optional property.
public void setMemoryReference(java.lang.String memoryReference)
This attribute is only required if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request.
This is an optional property.
@Pure public java.lang.String toString()
toString
in class java.lang.Object
@Pure public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
@Pure public int hashCode()
hashCode
in class java.lang.Object