Package com.google.protobuf
Class Value.Builder
- All Implemented Interfaces:
Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,ValueOrBuilder
,Cloneable
- Enclosing class:
Value
public static final class Value.Builder
extends GeneratedMessageV3.Builder<Value.Builder>
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
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(Descriptors.FieldDescriptor field, Object value) LikesetRepeatedField
, but appends the value as a new element.build()
Constructs the message based on the state of the Builder.LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields.clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.Represents a boolean value.Clears the field.Represents a repeated `Value`.Represents a null value.Represents a double value.TODO(jieluo): Clear it when all subclasses have implemented this method.Represents a string value.Represents a structured value.clone()
Clones the Builder.boolean
Represents a boolean value.Get an instance of the type with no fields set.static final Descriptors.Descriptor
Get the message's type's descriptor.Represents a repeated `Value`.Represents a repeated `Value`.Represents a repeated `Value`.Represents a repeated `Value`.Represents a null value.int
Represents a null value.double
Represents a double value.Represents a string value.Represents a string value.Represents a structured value.Represents a structured value.Represents a structured value.Represents a structured value.boolean
Represents a boolean value.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.mergeFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions.Mergeother
into the message being built.mergeListValue
(ListValue value) Represents a repeated `Value`.mergeStructValue
(Struct value) Represents a structured value.final Value.Builder
mergeUnknownFields
(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSet
for this message.setBoolValue
(boolean value) Represents a boolean value.setField
(Descriptors.FieldDescriptor field, Object value) Sets a field to the given value.setListValue
(ListValue value) Represents a repeated `Value`.setListValue
(ListValue.Builder builderForValue) Represents a repeated `Value`.setNullValue
(NullValue value) Represents a null value.setNullValueValue
(int value) Represents a null value.setNumberValue
(double value) Represents a double value.setRepeatedField
(Descriptors.FieldDescriptor field, int index, Object value) Sets an element of a repeated field to the given value.setStringValue
(String value) Represents a string value.setStringValueBytes
(ByteString value) Represents a string value.setStructValue
(Struct value) Represents a structured value.setStructValue
(Struct.Builder builderForValue) Represents a structured value.final Value.Builder
setUnknownFields
(UnknownFieldSet unknownFields) Set theUnknownFieldSet
for this message.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
dispose, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
kindCase_
private int kindCase_ -
kind_
-
structValueBuilder_
-
listValueBuilder_
-
-
Constructor Details
-
Builder
private Builder() -
Builder
-
-
Method Details
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageV3.Builder
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.Builder<Value.Builder>
-
clear
Description copied from class:GeneratedMessageV3.Builder
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.- Specified by:
clear
in interfaceMessage.Builder
- Specified by:
clear
in interfaceMessageLite.Builder
- Overrides:
clear
in classGeneratedMessageV3.Builder<Value.Builder>
-
getDescriptorForType
Description copied from interface:Message.Builder
Get the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType()
.- Specified by:
getDescriptorForType
in interfaceMessage.Builder
- Specified by:
getDescriptorForType
in interfaceMessageOrBuilder
- Overrides:
getDescriptorForType
in classGeneratedMessageV3.Builder<Value.Builder>
-
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
-
build
Description copied from interface:MessageLite.Builder
Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.- Specified by:
build
in interfaceMessage.Builder
- Specified by:
build
in interfaceMessageLite.Builder
-
buildPartial
Description copied from interface:MessageLite.Builder
LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.- Specified by:
buildPartial
in interfaceMessage.Builder
- Specified by:
buildPartial
in interfaceMessageLite.Builder
-
clone
Description copied from interface:MessageLite.Builder
Clones the Builder.- Specified by:
clone
in interfaceMessage.Builder
- Specified by:
clone
in interfaceMessageLite.Builder
- Overrides:
clone
in classGeneratedMessageV3.Builder<Value.Builder>
- See Also:
-
setField
Description copied from interface:Message.Builder
Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type thatMessageOrBuilder.getField(Descriptors.FieldDescriptor)
would return.- Specified by:
setField
in interfaceMessage.Builder
- Overrides:
setField
in classGeneratedMessageV3.Builder<Value.Builder>
-
clearField
Description copied from interface:Message.Builder
Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.- Specified by:
clearField
in interfaceMessage.Builder
- Overrides:
clearField
in classGeneratedMessageV3.Builder<Value.Builder>
-
clearOneof
Description copied from class:AbstractMessage.Builder
TODO(jieluo): Clear it when all subclasses have implemented this method.- Specified by:
clearOneof
in interfaceMessage.Builder
- Overrides:
clearOneof
in classGeneratedMessageV3.Builder<Value.Builder>
-
setRepeatedField
Description copied from interface:Message.Builder
Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type thatMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
would return.- Specified by:
setRepeatedField
in interfaceMessage.Builder
- Overrides:
setRepeatedField
in classGeneratedMessageV3.Builder<Value.Builder>
-
addRepeatedField
Description copied from interface:Message.Builder
LikesetRepeatedField
, but appends the value as a new element.- Specified by:
addRepeatedField
in interfaceMessage.Builder
- Overrides:
addRepeatedField
in classGeneratedMessageV3.Builder<Value.Builder>
-
mergeFrom
Description copied from interface:Message.Builder
Mergeother
into the message being built.other
must have the exact same type asthis
(i.e.getDescriptorForType() == other.getDescriptorForType()
).Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set inother
, thenother
's value overwrites the value in this message.
* For singular message fields, if the field is set inother
, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements inother
are concatenated with the elements in this message.
* For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.This is equivalent to the
Message::MergeFrom
method in C++.- Specified by:
mergeFrom
in interfaceMessage.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<Value.Builder>
-
mergeFrom
-
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.Builder<Value.Builder>
-
mergeFrom
public Value.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.Builder
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions. The extensions that you want to be able to parse must be registered inextensionRegistry
. Extensions not in the registry will be treated as unknown fields.- Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfaceMessageLite.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<Value.Builder>
- Throws:
IOException
-
getKindCase
- Specified by:
getKindCase
in interfaceValueOrBuilder
-
clearKind
-
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.
-
setNullValueValue
Represents a null value.
.google.protobuf.NullValue null_value = 1;
- Parameters:
value
- The enum numeric value on the wire for nullValue to set.- Returns:
- This builder for chaining.
-
getNullValue
Represents a null value.
.google.protobuf.NullValue null_value = 1;
- Specified by:
getNullValue
in interfaceValueOrBuilder
- Returns:
- The nullValue.
-
setNullValue
Represents a null value.
.google.protobuf.NullValue null_value = 1;
- Parameters:
value
- The nullValue to set.- Returns:
- This builder for chaining.
-
clearNullValue
Represents a null value.
.google.protobuf.NullValue null_value = 1;
- Returns:
- This builder for chaining.
-
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.
-
setNumberValue
Represents a double value.
double number_value = 2;
- Parameters:
value
- The numberValue to set.- Returns:
- This builder for chaining.
-
clearNumberValue
Represents a double value.
double number_value = 2;
- Returns:
- This builder for chaining.
-
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.
-
setStringValue
Represents a string value.
string string_value = 3;
- Parameters:
value
- The stringValue to set.- Returns:
- This builder for chaining.
-
clearStringValue
Represents a string value.
string string_value = 3;
- Returns:
- This builder for chaining.
-
setStringValueBytes
Represents a string value.
string string_value = 3;
- Parameters:
value
- The bytes for stringValue to set.- Returns:
- This builder for chaining.
-
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.
-
setBoolValue
Represents a boolean value.
bool bool_value = 4;
- Parameters:
value
- The boolValue to set.- Returns:
- This builder for chaining.
-
clearBoolValue
Represents a boolean value.
bool bool_value = 4;
- Returns:
- This builder for chaining.
-
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.
-
setStructValue
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
setStructValue
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
mergeStructValue
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
clearStructValue
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
getStructValueBuilder
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
getStructValueOrBuilder
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
- Specified by:
getStructValueOrBuilder
in interfaceValueOrBuilder
-
getStructValueFieldBuilder
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
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.
-
setListValue
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
setListValue
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
mergeListValue
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
clearListValue
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
getListValueBuilder
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
getListValueOrBuilder
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
- Specified by:
getListValueOrBuilder
in interfaceValueOrBuilder
-
getListValueFieldBuilder
private SingleFieldBuilderV3<ListValue,ListValue.Builder, getListValueFieldBuilder()ListValueOrBuilder> Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
setUnknownFields
Description copied from interface:Message.Builder
Set theUnknownFieldSet
for this message.- Specified by:
setUnknownFields
in interfaceMessage.Builder
- Overrides:
setUnknownFields
in classGeneratedMessageV3.Builder<Value.Builder>
-
mergeUnknownFields
Description copied from interface:Message.Builder
Merge some unknown fields into theUnknownFieldSet
for this message.- Specified by:
mergeUnknownFields
in interfaceMessage.Builder
- Overrides:
mergeUnknownFields
in classGeneratedMessageV3.Builder<Value.Builder>
-