Class Variable (1.34.0) 

public final class Variable extends GeneratedMessageV3 implements VariableOrBuilder

Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented:

1) A simple variable:

 int x = 5

 { name: "x", value: "5", type: "int" }  // Captured variable

2) A compound object:

 struct T {
     int m1;
     int m2;
 };
 T x = { 3, 7 };

 {  // Captured variable
     name: "x",
     type: "T",
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

3) A pointer where the pointee was captured:

 T x = { 3, 7 };
 T* p = &x;

 {   // Captured variable
     name: "p",
     type: "T*",
     value: "0x00500500",
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

4) A pointer where the pointee was not captured:

 T* p = new T;

 {   // Captured variable
     name: "p",
     type: "T*",
     value: "0x00400400"
     status { is_error: true, description { format: "unavailable" } }
 }

The status should describe the reason for the missing value, such as <optimized out>, <inaccessible>, <pointers limit reached>.

Note that a null pointer should not have members.

5) An unnamed value:

 int* p = new int(7);

 {   // Captured variable
     name: "p",
     value: "0x00500500",
     type: "int*",
     members { value: "7", type: "int" } }

6) An unnamed pointer where the pointee was not captured:

 int* p = new int(7);
 int** pp = &amp;p;

 {  // Captured variable
     name: "pp",
     value: "0x00500500",
     type: "int**",
     members {
         value: "0x00400400",
         type: "int*"
         status {
             is_error: true,
             description: { format: "unavailable" } }
         }
     }
 }

To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_table_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable.

When using the shared variable table, the following variables:

 T x = { 3, 7 };
 T* p = &amp;x;
 T&amp; r = x;

 { name: "x", var_table_index: 3, type: "T" }  // Captured variables
 { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
 { name: "r", type="T&amp;", var_table_index: 3 }

 {  // Shared variable table entry #3:
     members { name: "m1", value: "3", type: "int" },
     members { name: "m2", value: "7", type: "int" }
 }

Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references.

The type field is optional. The debugger agent may or may not support it.

Protobuf type google.devtools.clouddebugger.v2.Variable

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Variable

Implements

VariableOrBuilder

Static Fields

MEMBERS_FIELD_NUMBER

public static final int MEMBERS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

VAR_TABLE_INDEX_FIELD_NUMBER

public static final int VAR_TABLE_INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Variable getDefaultInstance()
Returns
TypeDescription
Variable

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Variable.Builder newBuilder()
Returns
TypeDescription
Variable.Builder

newBuilder(Variable prototype)

public static Variable.Builder newBuilder(Variable prototype)
Parameter
NameDescription
prototypeVariable
Returns
TypeDescription
Variable.Builder

parseDelimitedFrom(InputStream input)

public static Variable parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Variable
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Variable parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Variable
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Variable parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Variable
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Variable parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Variable
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Variable parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Variable
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Variable parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Variable
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Variable parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Variable
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Variable parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Variable
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Variable parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Variable
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Variable parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Variable
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Variable parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Variable
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Variable parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Variable
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Variable> parser()
Returns
TypeDescription
Parser<Variable>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Variable getDefaultInstanceForType()
Returns
TypeDescription
Variable

getMembers(int index)

public Variable getMembers(int index)

Members contained or pointed to by the variable.

repeated .google.devtools.clouddebugger.v2.Variable members = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Variable

getMembersCount()

public int getMembersCount()

Members contained or pointed to by the variable.

repeated .google.devtools.clouddebugger.v2.Variable members = 3;

Returns
TypeDescription
int

getMembersList()

public List<Variable> getMembersList()

Members contained or pointed to by the variable.

repeated .google.devtools.clouddebugger.v2.Variable members = 3;

Returns
TypeDescription
List<Variable>

getMembersOrBuilder(int index)

public VariableOrBuilder getMembersOrBuilder(int index)

Members contained or pointed to by the variable.

repeated .google.devtools.clouddebugger.v2.Variable members = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
VariableOrBuilder

getMembersOrBuilderList()

public List<? extends VariableOrBuilder> getMembersOrBuilderList()

Members contained or pointed to by the variable.

repeated .google.devtools.clouddebugger.v2.Variable members = 3;

Returns
TypeDescription
List<? extends com.google.devtools.clouddebugger.v2.VariableOrBuilder>

getName()

public String getName()

Name of the variable, if any.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the variable, if any.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Variable> getParserForType()
Returns
TypeDescription
Parser<Variable>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatus()

public StatusMessage getStatus()

Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state.

The message may refer to variable name with refers_to set to VARIABLE_NAME. Alternatively refers_to will be set to VARIABLE_VALUE. In either case variable value and members will be unset.

Example of error message applied to name: Invalid expression syntax.

Example of information message applied to value: Not captured.

Examples of error message applied to value:

  • Malformed string,
  • Field f not found in class C
  • Null pointer dereference

.google.devtools.clouddebugger.v2.StatusMessage status = 5;

Returns
TypeDescription
StatusMessage

The status.

getStatusOrBuilder()

public StatusMessageOrBuilder getStatusOrBuilder()

Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state.

The message may refer to variable name with refers_to set to VARIABLE_NAME. Alternatively refers_to will be set to VARIABLE_VALUE. In either case variable value and members will be unset.

Example of error message applied to name: Invalid expression syntax.

Example of information message applied to value: Not captured.

Examples of error message applied to value:

  • Malformed string,
  • Field f not found in class C
  • Null pointer dereference

.google.devtools.clouddebugger.v2.StatusMessage status = 5;

Returns
TypeDescription
StatusMessageOrBuilder

getType()

public String getType()

Variable type (e.g. MyClass). If the variable is split with var_table_index, type goes next to value. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.

string type = 6;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Variable type (e.g. MyClass). If the variable is split with var_table_index, type goes next to value. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.

string type = 6;

Returns
TypeDescription
ByteString

The bytes for type.

getValue()

public String getValue()

Simple value of the variable.

string value = 2;

Returns
TypeDescription
String

The value.

getValueBytes()

public ByteString getValueBytes()

Simple value of the variable.

string value = 2;

Returns
TypeDescription
ByteString

The bytes for value.

getVarTableIndex()

public Int32Value getVarTableIndex()

Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_table_index field is an index into variable_table in Breakpoint.

.google.protobuf.Int32Value var_table_index = 4;

Returns
TypeDescription
Int32Value

The varTableIndex.

getVarTableIndexOrBuilder()

public Int32ValueOrBuilder getVarTableIndexOrBuilder()

Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_table_index field is an index into variable_table in Breakpoint.

.google.protobuf.Int32Value var_table_index = 4;

Returns
TypeDescription
Int32ValueOrBuilder

hasStatus()

public boolean hasStatus()

Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state.

The message may refer to variable name with refers_to set to VARIABLE_NAME. Alternatively refers_to will be set to VARIABLE_VALUE. In either case variable value and members will be unset.

Example of error message applied to name: Invalid expression syntax.

Example of information message applied to value: Not captured.

Examples of error message applied to value:

  • Malformed string,
  • Field f not found in class C
  • Null pointer dereference

.google.devtools.clouddebugger.v2.StatusMessage status = 5;

Returns
TypeDescription
boolean

Whether the status field is set.

hasVarTableIndex()

public boolean hasVarTableIndex()

Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_table_index field is an index into variable_table in Breakpoint.

.google.protobuf.Int32Value var_table_index = 4;

Returns
TypeDescription
boolean

Whether the varTableIndex field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Variable.Builder newBuilderForType()
Returns
TypeDescription
Variable.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Variable.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Variable.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Variable.Builder toBuilder()
Returns
TypeDescription
Variable.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException