Package com.google.protobuf
Class Value
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.protobuf.Value
- All Implemented Interfaces:
Message
,MessageLite
,MessageLiteOrBuilder
,MessageOrBuilder
,ValueOrBuilder
,Serializable
`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for `Value` is JSON value.Protobuf type
google.protobuf.Value
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.static enum
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,
BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
private static final Value
private Object
private int
static final int
private byte
static final int
static final int
private static final long
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Value()
private
Value
(GeneratedMessageV3.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the specified object with this message for equality.boolean
Represents a boolean value.static Value
Get an instance of the type with no fields set.static final Descriptors.Descriptor
Represents a repeated `Value`.Represents a repeated `Value`.Represents a null value.int
Represents a null value.double
Represents a double value.Gets the parser for a message of the same type as this message.int
Get the number of bytes required to encode this message.Represents a string value.Represents a string value.Represents a structured value.Represents a structured value.final UnknownFieldSet
Get theUnknownFieldSet
for this message.boolean
Represents a boolean value.int
hashCode()
Returns the hash code value for this message.boolean
Represents a repeated `Value`.boolean
Represents a null value.boolean
Represents a double value.boolean
Represents a string value.boolean
Represents a structured value.protected GeneratedMessageV3.FieldAccessorTable
Get the FieldAccessorTable for this type.final boolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.static Value.Builder
static Value.Builder
newBuilder
(Value prototype) Constructs a new builder for a message of the same type as this message.protected Value.Builder
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.protected Object
Creates a new instance of this message type.static Value
parseDelimitedFrom
(InputStream input) static Value
parseDelimitedFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) static Value
parseFrom
(byte[] data) static Value
parseFrom
(byte[] data, ExtensionRegistryLite extensionRegistry) static Value
parseFrom
(ByteString data) static Value
parseFrom
(ByteString data, ExtensionRegistryLite extensionRegistry) static Value
parseFrom
(CodedInputStream input) static Value
parseFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) static Value
parseFrom
(InputStream input) static Value
parseFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) static Value
parseFrom
(ByteBuffer data) static Value
parseFrom
(ByteBuffer data, ExtensionRegistryLite extensionRegistry) parser()
Constructs a builder initialized with the current message.void
writeTo
(CodedOutputStream output) Serializes the message and writes it tooutput
.Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getDescriptorForType, getField, getFieldRaw, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
kindCase_
private int kindCase_ -
kind_
-
NULL_VALUE_FIELD_NUMBER
public static final int NULL_VALUE_FIELD_NUMBER- See Also:
-
NUMBER_VALUE_FIELD_NUMBER
public static final int NUMBER_VALUE_FIELD_NUMBER- See Also:
-
STRING_VALUE_FIELD_NUMBER
public static final int STRING_VALUE_FIELD_NUMBER- See Also:
-
BOOL_VALUE_FIELD_NUMBER
public static final int BOOL_VALUE_FIELD_NUMBER- See Also:
-
STRUCT_VALUE_FIELD_NUMBER
public static final int STRUCT_VALUE_FIELD_NUMBER- See Also:
-
LIST_VALUE_FIELD_NUMBER
public static final int LIST_VALUE_FIELD_NUMBER- See Also:
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
Value
-
Value
private Value()
-
-
Method Details
-
newInstance
Description copied from class:GeneratedMessageV3
Creates a new instance of this message type. Overridden in the generated code.- Overrides:
newInstance
in classGeneratedMessageV3
-
getUnknownFields
Description copied from interface:MessageOrBuilder
Get theUnknownFieldSet
for this message.- Specified by:
getUnknownFields
in interfaceMessageOrBuilder
- Overrides:
getUnknownFields
in classGeneratedMessageV3
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageV3
Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.- Specified by:
internalGetFieldAccessorTable
in classGeneratedMessageV3
-
getKindCase
- Specified by:
getKindCase
in interfaceValueOrBuilder
-
hasNullValue
public boolean hasNullValue()Represents a null value.
.google.protobuf.NullValue null_value = 1;
- Specified by:
hasNullValue
in interfaceValueOrBuilder
- Returns:
- Whether the nullValue field is set.
-
getNullValueValue
public int getNullValueValue()Represents a null value.
.google.protobuf.NullValue null_value = 1;
- Specified by:
getNullValueValue
in interfaceValueOrBuilder
- Returns:
- The enum numeric value on the wire for nullValue.
-
getNullValue
Represents a null value.
.google.protobuf.NullValue null_value = 1;
- Specified by:
getNullValue
in interfaceValueOrBuilder
- Returns:
- The nullValue.
-
hasNumberValue
public boolean hasNumberValue()Represents a double value.
double number_value = 2;
- Specified by:
hasNumberValue
in interfaceValueOrBuilder
- Returns:
- Whether the numberValue field is set.
-
getNumberValue
public double getNumberValue()Represents a double value.
double number_value = 2;
- Specified by:
getNumberValue
in interfaceValueOrBuilder
- Returns:
- The numberValue.
-
hasStringValue
public boolean hasStringValue()Represents a string value.
string string_value = 3;
- Specified by:
hasStringValue
in interfaceValueOrBuilder
- Returns:
- Whether the stringValue field is set.
-
getStringValue
Represents a string value.
string string_value = 3;
- Specified by:
getStringValue
in interfaceValueOrBuilder
- Returns:
- The stringValue.
-
getStringValueBytes
Represents a string value.
string string_value = 3;
- Specified by:
getStringValueBytes
in interfaceValueOrBuilder
- Returns:
- The bytes for stringValue.
-
hasBoolValue
public boolean hasBoolValue()Represents a boolean value.
bool bool_value = 4;
- Specified by:
hasBoolValue
in interfaceValueOrBuilder
- Returns:
- Whether the boolValue field is set.
-
getBoolValue
public boolean getBoolValue()Represents a boolean value.
bool bool_value = 4;
- Specified by:
getBoolValue
in interfaceValueOrBuilder
- Returns:
- The boolValue.
-
hasStructValue
public boolean hasStructValue()Represents a structured value.
.google.protobuf.Struct struct_value = 5;
- Specified by:
hasStructValue
in interfaceValueOrBuilder
- Returns:
- Whether the structValue field is set.
-
getStructValue
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
- Specified by:
getStructValue
in interfaceValueOrBuilder
- Returns:
- The structValue.
-
getStructValueOrBuilder
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
- Specified by:
getStructValueOrBuilder
in interfaceValueOrBuilder
-
hasListValue
public boolean hasListValue()Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
- Specified by:
hasListValue
in interfaceValueOrBuilder
- Returns:
- Whether the listValue field is set.
-
getListValue
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
- Specified by:
getListValue
in interfaceValueOrBuilder
- Returns:
- The listValue.
-
getListValueOrBuilder
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
- Specified by:
getListValueOrBuilder
in interfaceValueOrBuilder
-
isInitialized
public final boolean isInitialized()Description copied from interface:MessageLiteOrBuilder
Returns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessageV3
-
writeTo
Description copied from interface:MessageLite
Serializes the message and writes it tooutput
. This does not flush or close the stream.- Specified by:
writeTo
in interfaceMessageLite
- Overrides:
writeTo
in classGeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()Description copied from interface:MessageLite
Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.- Specified by:
getSerializedSize
in interfaceMessageLite
- Overrides:
getSerializedSize
in classGeneratedMessageV3
-
equals
Description copied from interface:Message
Compares the specified object with this message for equality. Returnstrue
if the given object is a message of the same type (as defined bygetDescriptorForType()
) and has identical values for all of its fields. Subclasses must implement this; inheritingObject.equals()
is incorrect.- Specified by:
equals
in interfaceMessage
- Overrides:
equals
in classAbstractMessage
- Parameters:
obj
- object to be compared for equality with this message- Returns:
true
if the specified object is equal to this message
-
hashCode
public int hashCode()Description copied from interface:Message
Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheritingObject.hashCode()
is incorrect.- Specified by:
hashCode
in interfaceMessage
- Overrides:
hashCode
in classAbstractMessage
- Returns:
- the hash code value for this message
- See Also:
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Value parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Value parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Value parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Value parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Value parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Value parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
Description copied from interface:MessageLite
Constructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForType
in interfaceMessage
- Specified by:
newBuilderForType
in interfaceMessageLite
-
newBuilder
-
newBuilder
-
toBuilder
Description copied from interface:MessageLite
Constructs a builder initialized with the current message. Use this to derive a new message from the current one.- Specified by:
toBuilder
in interfaceMessage
- Specified by:
toBuilder
in interfaceMessageLite
-
newBuilderForType
Description copied from class:GeneratedMessageV3
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.- Specified by:
newBuilderForType
in classGeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
Description copied from interface:MessageLite
Gets the parser for a message of the same type as this message.- Specified by:
getParserForType
in interfaceMessage
- Specified by:
getParserForType
in interfaceMessageLite
- Overrides:
getParserForType
in classGeneratedMessageV3
-
getDefaultInstanceForType
Description copied from interface:MessageLiteOrBuilder
Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from thegetDefaultInstance()
method of generated message classes in that this method is an abstract method of theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder
-