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

public final class Value
extends GeneratedMessageV3
implements ValueOrBuilder

`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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Value.Builder	`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	Value.KindCase

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BOOL_VALUE_FIELD_NUMBER
private static final Value	DEFAULT_INSTANCE
private Object	kind_
private int	kindCase_
static final int	LIST_VALUE_FIELD_NUMBER
private byte	memoizedIsInitialized
static final int	NULL_VALUE_FIELD_NUMBER
static final int	NUMBER_VALUE_FIELD_NUMBER
private static final Parser<Value>	PARSER
private static final long	serialVersionUID
static final int	STRING_VALUE_FIELD_NUMBER
static final int	STRUCT_VALUE_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Value()
private	Value(GeneratedMessageV3.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares the specified object with this message for equality.
boolean	getBoolValue()	Represents a boolean value.
static Value	getDefaultInstance()
Value	getDefaultInstanceForType()	Get an instance of the type with no fields set.
static final Descriptors.Descriptor	getDescriptor()
Value.KindCase	getKindCase()
ListValue	getListValue()	Represents a repeated `Value`.
ListValueOrBuilder	getListValueOrBuilder()	Represents a repeated `Value`.
NullValue	getNullValue()	Represents a null value.
int	getNullValueValue()	Represents a null value.
double	getNumberValue()	Represents a double value.
Parser<Value>	getParserForType()	Gets the parser for a message of the same type as this message.
int	getSerializedSize()	Get the number of bytes required to encode this message.
String	getStringValue()	Represents a string value.
ByteString	getStringValueBytes()	Represents a string value.
Struct	getStructValue()	Represents a structured value.
StructOrBuilder	getStructValueOrBuilder()	Represents a structured value.
final UnknownFieldSet	getUnknownFields()	Get the UnknownFieldSet for this message.
boolean	hasBoolValue()	Represents a boolean value.
int	hashCode()	Returns the hash code value for this message.
boolean	hasListValue()	Represents a repeated `Value`.
boolean	hasNullValue()	Represents a null value.
boolean	hasNumberValue()	Represents a double value.
boolean	hasStringValue()	Represents a string value.
boolean	hasStructValue()	Represents a structured value.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
final boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static Value.Builder	newBuilder()
static Value.Builder	newBuilder(Value prototype)
Value.Builder	newBuilderForType()	Constructs a new builder for a message of the same type as this message.
protected Value.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)	TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)	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)
static Parser<Value>	parser()
Value.Builder	toBuilder()	Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output)	Serializes the message and writes it to output.

Methods inherited from class 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 AbstractMessage

compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

kindCase_

private int kindCase_

kind_

private Object kind_

NULL_VALUE_FIELD_NUMBER

public static final int NULL_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

NUMBER_VALUE_FIELD_NUMBER

public static final int NUMBER_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

STRING_VALUE_FIELD_NUMBER

public static final int STRING_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

BOOL_VALUE_FIELD_NUMBER

public static final int BOOL_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

STRUCT_VALUE_FIELD_NUMBER

public static final int STRUCT_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

LIST_VALUE_FIELD_NUMBER

public static final int LIST_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final Value DEFAULT_INSTANCE

PARSER

private static final Parser<Value> PARSER

Constructor Details

Value

private Value(GeneratedMessageV3.Builder<?> builder)

Value

private Value()

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Description copied from class: GeneratedMessageV3

Creates a new instance of this message type. Overridden in the generated code.

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable 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 class GeneratedMessageV3

getKindCase

public Value.KindCase getKindCase()

Specified by:

getKindCase in interface ValueOrBuilder

hasNullValue

public boolean hasNullValue()

Represents a null value.

.google.protobuf.NullValue null_value = 1;

Specified by:

hasNullValue in interface ValueOrBuilder

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 interface ValueOrBuilder

Returns:

The enum numeric value on the wire for nullValue.

getNullValue

public NullValue getNullValue()

Represents a null value.

.google.protobuf.NullValue null_value = 1;

Specified by:

getNullValue in interface ValueOrBuilder

Returns:

The nullValue.

hasNumberValue

public boolean hasNumberValue()

Represents a double value.

double number_value = 2;

Specified by:

hasNumberValue in interface ValueOrBuilder

Returns:

Whether the numberValue field is set.

getNumberValue

public double getNumberValue()

Represents a double value.

double number_value = 2;

Specified by:

getNumberValue in interface ValueOrBuilder

Returns:

The numberValue.

hasStringValue

public boolean hasStringValue()

Represents a string value.

string string_value = 3;

Specified by:

hasStringValue in interface ValueOrBuilder

Returns:

Whether the stringValue field is set.

getStringValue

public String getStringValue()

Represents a string value.

string string_value = 3;

Specified by:

getStringValue in interface ValueOrBuilder

Returns:

The stringValue.

getStringValueBytes

public ByteString getStringValueBytes()

Represents a string value.

string string_value = 3;

Specified by:

getStringValueBytes in interface ValueOrBuilder

Returns:

The bytes for stringValue.

hasBoolValue

public boolean hasBoolValue()

Represents a boolean value.

bool bool_value = 4;

Specified by:

hasBoolValue in interface ValueOrBuilder

Returns:

Whether the boolValue field is set.

getBoolValue

public boolean getBoolValue()

Represents a boolean value.

bool bool_value = 4;

Specified by:

getBoolValue in interface ValueOrBuilder

Returns:

The boolValue.

hasStructValue

public boolean hasStructValue()

Represents a structured value.

.google.protobuf.Struct struct_value = 5;

Specified by:

hasStructValue in interface ValueOrBuilder

Returns:

Whether the structValue field is set.

getStructValue

public Struct getStructValue()

Represents a structured value.

.google.protobuf.Struct struct_value = 5;

Specified by:

getStructValue in interface ValueOrBuilder

Returns:

The structValue.

getStructValueOrBuilder

public StructOrBuilder getStructValueOrBuilder()

Represents a structured value.

.google.protobuf.Struct struct_value = 5;

Specified by:

getStructValueOrBuilder in interface ValueOrBuilder

hasListValue

public boolean hasListValue()

Represents a repeated `Value`.

.google.protobuf.ListValue list_value = 6;

Specified by:

hasListValue in interface ValueOrBuilder

Returns:

Whether the listValue field is set.

getListValue

public ListValue getListValue()

Represents a repeated `Value`.

.google.protobuf.ListValue list_value = 6;

Specified by:

getListValue in interface ValueOrBuilder

Returns:

The listValue.

getListValueOrBuilder

public ListValueOrBuilder getListValueOrBuilder()

Represents a repeated `Value`.

.google.protobuf.ListValue list_value = 6;

Specified by:

getListValueOrBuilder in interface ValueOrBuilder

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.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

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 interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Description copied from interface: Message

Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

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; inheriting Object.hashCode() is incorrect.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

• Map.hashCode()

parseFrom

public static Value parseFrom(ByteBuffer data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(ByteString data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(byte[] data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Value parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Value parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Value parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseFrom

public static Value parseFrom(CodedInputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Value parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

newBuilderForType

public Value.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Value.Builder newBuilder()

newBuilder

public static Value.Builder newBuilder(Value prototype)

toBuilder

public Value.Builder 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 interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Value.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Description copied from class: GeneratedMessageV3

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Value getDefaultInstance()

parser

public static Parser<Value> parser()

getParserForType

public Parser<Value> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Value 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 the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder