Package com.google.devtools.clouddebugger.v2

Class Variable

  • All Implemented Interfaces:
    VariableOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Variable
extends com.google.protobuf.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 = &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 = &x;
     T& 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&", 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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Variable.Builder
      Represents a variable or an argument possibly of a compound object type.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Name of the variable, if any.
        string name = 1;
        Specified by:
        getName in interface VariableOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the variable, if any.
        string name = 1;
        Specified by:
        getNameBytes in interface VariableOrBuilder
        Returns:
        The bytes for name.

      • getValue

        public String getValue()
         Simple value of the variable.
        string value = 2;
        Specified by:
        getValue in interface VariableOrBuilder
        Returns:
        The value.

      • getValueBytes

        public com.google.protobuf.ByteString getValueBytes()
         Simple value of the variable.
        string value = 2;
        Specified by:
        getValueBytes in interface VariableOrBuilder
        Returns:
        The bytes for value.

      • 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;
        Specified by:
        getType in interface VariableOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.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;
        Specified by:
        getTypeBytes in interface VariableOrBuilder
        Returns:
        The bytes for type.

      • getMembersList

        public List<Variable> getMembersList()
         Members contained or pointed to by the variable.
        repeated .google.devtools.clouddebugger.v2.Variable members = 3;
        Specified by:
        getMembersList in interface VariableOrBuilder

      • getMembersCount

        public int getMembersCount()
         Members contained or pointed to by the variable.
        repeated .google.devtools.clouddebugger.v2.Variable members = 3;
        Specified by:
        getMembersCount in interface VariableOrBuilder

      • getMembers

        public Variable getMembers​(int index)
         Members contained or pointed to by the variable.
        repeated .google.devtools.clouddebugger.v2.Variable members = 3;
        Specified by:
        getMembers in interface VariableOrBuilder

      • 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;
        Specified by:
        hasVarTableIndex in interface VariableOrBuilder
        Returns:
        Whether the varTableIndex field is set.

      • getVarTableIndex

        public com.google.protobuf.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;
        Specified by:
        getVarTableIndex in interface VariableOrBuilder
        Returns:
        The varTableIndex.

      • getVarTableIndexOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getVarTableIndexOrBuilder in interface VariableOrBuilder

      • 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;
        Specified by:
        hasStatus in interface VariableOrBuilder
        Returns:
        Whether the status field is set.

      • 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;
        Specified by:
        getStatus in interface VariableOrBuilder
        Returns:
        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;
        Specified by:
        getStatusOrBuilder in interface VariableOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Variable parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Variable parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Variable parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Variable parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Variable parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Variable parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Variable parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Variable.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Variable.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Variable.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Variable getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Variable> parser()

      • getParserForType

        public com.google.protobuf.Parser<Variable> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Variable getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder