Package com.google.protobuf
Class Value.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Value.Builder>
-
- com.google.protobuf.Value.Builder
-
- All Implemented Interfaces:
Message.Builder,MessageLite.Builder,MessageLiteOrBuilder,MessageOrBuilder,ValueOrBuilder,java.lang.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 that variants, absence of any variant indicates an error. The JSON representation for `Value` is JSON value.
Protobuf typegoogle.protobuf.Value
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Value.BuilderaddRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)LikesetRepeatedField, but appends the value as a new element.Valuebuild()Constructs the message based on the state of the Builder.ValuebuildPartial()LikeMessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.Value.Builderclear()Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.Value.BuilderclearBoolValue()Represents a boolean value.Value.BuilderclearField(Descriptors.FieldDescriptor field)Clears the field.Value.BuilderclearKind()Value.BuilderclearListValue()Represents a repeated `Value`.Value.BuilderclearNullValue()Represents a null value.Value.BuilderclearNumberValue()Represents a double value.Value.BuilderclearOneof(Descriptors.OneofDescriptor oneof)TODO(jieluo): Clear it when all subclasses have implemented this method.Value.BuilderclearStringValue()Represents a string value.Value.BuilderclearStructValue()Represents a structured value.Value.Builderclone()Clones the Builder.booleangetBoolValue()Represents a boolean value.ValuegetDefaultInstanceForType()Get an instance of the type with no fields set.static Descriptors.DescriptorgetDescriptor()Descriptors.DescriptorgetDescriptorForType()Get the message's type's descriptor.Value.KindCasegetKindCase()ListValuegetListValue()Represents a repeated `Value`.ListValue.BuildergetListValueBuilder()Represents a repeated `Value`.ListValueOrBuildergetListValueOrBuilder()Represents a repeated `Value`.NullValuegetNullValue()Represents a null value.intgetNullValueValue()Represents a null value.doublegetNumberValue()Represents a double value.java.lang.StringgetStringValue()Represents a string value.ByteStringgetStringValueBytes()Represents a string value.StructgetStructValue()Represents a structured value.Struct.BuildergetStructValueBuilder()Represents a structured value.StructOrBuildergetStructValueOrBuilder()Represents a structured value.booleanhasListValue()Represents a repeated `Value`.booleanhasStructValue()Represents a structured value.protected GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()Get the FieldAccessorTable for this type.booleanisInitialized()Returns true if all required fields in the message and all embedded messages are set, false otherwise.Value.BuildermergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)LikeMessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.Value.BuildermergeFrom(Message other)Mergeotherinto the message being built.Value.BuildermergeFrom(Value other)Value.BuildermergeListValue(ListValue value)Represents a repeated `Value`.Value.BuildermergeStructValue(Struct value)Represents a structured value.Value.BuildermergeUnknownFields(UnknownFieldSet unknownFields)Merge some unknown fields into theUnknownFieldSetfor this message.Value.BuildersetBoolValue(boolean value)Represents a boolean value.Value.BuildersetField(Descriptors.FieldDescriptor field, java.lang.Object value)Sets a field to the given value.Value.BuildersetListValue(ListValue value)Represents a repeated `Value`.Value.BuildersetListValue(ListValue.Builder builderForValue)Represents a repeated `Value`.Value.BuildersetNullValue(NullValue value)Represents a null value.Value.BuildersetNullValueValue(int value)Represents a null value.Value.BuildersetNumberValue(double value)Represents a double value.Value.BuildersetRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)Sets an element of a repeated field to the given value.Value.BuildersetStringValue(java.lang.String value)Represents a string value.Value.BuildersetStringValueBytes(ByteString value)Represents a string value.Value.BuildersetStructValue(Struct value)Represents a structured value.Value.BuildersetStructValue(Struct.Builder builderForValue)Represents a structured value.Value.BuildersetUnknownFields(UnknownFieldSet unknownFields)Set theUnknownFieldSetfor this message.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, 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
-
-
-
-
Method Detail
-
getDescriptor
public static final Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Description copied from class:GeneratedMessageV3.BuilderGet 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:
internalGetFieldAccessorTablein classGeneratedMessageV3.Builder<Value.Builder>
-
clear
public Value.Builder clear()
Description copied from class:GeneratedMessageV3.BuilderCalled by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.- Specified by:
clearin interfaceMessage.Builder- Specified by:
clearin interfaceMessageLite.Builder- Overrides:
clearin classGeneratedMessageV3.Builder<Value.Builder>
-
getDescriptorForType
public Descriptors.Descriptor getDescriptorForType()
Description copied from interface:Message.BuilderGet the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType().- Specified by:
getDescriptorForTypein interfaceMessage.Builder- Specified by:
getDescriptorForTypein interfaceMessageOrBuilder- Overrides:
getDescriptorForTypein classGeneratedMessageV3.Builder<Value.Builder>
-
getDefaultInstanceForType
public Value getDefaultInstanceForType()
Description copied from interface:MessageLiteOrBuilderGet 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 theMessageLiteinterface whereasgetDefaultInstance()is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-
build
public Value build()
Description copied from interface:MessageLite.BuilderConstructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.- Specified by:
buildin interfaceMessage.Builder- Specified by:
buildin interfaceMessageLite.Builder
-
buildPartial
public Value buildPartial()
Description copied from interface:MessageLite.BuilderLikeMessageLite.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:
buildPartialin interfaceMessage.Builder- Specified by:
buildPartialin interfaceMessageLite.Builder
-
clone
public Value.Builder clone()
Description copied from interface:MessageLite.BuilderClones the Builder.- Specified by:
clonein interfaceMessage.Builder- Specified by:
clonein interfaceMessageLite.Builder- Overrides:
clonein classGeneratedMessageV3.Builder<Value.Builder>- See Also:
Object.clone()
-
setField
public Value.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
Description copied from interface:Message.BuilderSets 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:
setFieldin interfaceMessage.Builder- Overrides:
setFieldin classGeneratedMessageV3.Builder<Value.Builder>
-
clearField
public Value.Builder clearField(Descriptors.FieldDescriptor field)
Description copied from interface:Message.BuilderClears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.- Specified by:
clearFieldin interfaceMessage.Builder- Overrides:
clearFieldin classGeneratedMessageV3.Builder<Value.Builder>
-
clearOneof
public Value.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Description copied from class:AbstractMessage.BuilderTODO(jieluo): Clear it when all subclasses have implemented this method.- Specified by:
clearOneofin interfaceMessage.Builder- Overrides:
clearOneofin classGeneratedMessageV3.Builder<Value.Builder>
-
setRepeatedField
public Value.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Description copied from interface:Message.BuilderSets 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:
setRepeatedFieldin interfaceMessage.Builder- Overrides:
setRepeatedFieldin classGeneratedMessageV3.Builder<Value.Builder>
-
addRepeatedField
public Value.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
Description copied from interface:Message.BuilderLikesetRepeatedField, but appends the value as a new element.- Specified by:
addRepeatedFieldin interfaceMessage.Builder- Overrides:
addRepeatedFieldin classGeneratedMessageV3.Builder<Value.Builder>
-
mergeFrom
public Value.Builder mergeFrom(Message other)
Description copied from interface:Message.BuilderMergeotherinto the message being built.othermust 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 inotherare 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::MergeFrommethod in C++.- Specified by:
mergeFromin interfaceMessage.Builder- Overrides:
mergeFromin classAbstractMessage.Builder<Value.Builder>
-
mergeFrom
public Value.Builder mergeFrom(Value other)
-
isInitialized
public final boolean isInitialized()
Description copied from interface:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessageV3.Builder<Value.Builder>
-
mergeFrom
public Value.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
Description copied from interface:MessageLite.BuilderLikeMessageLite.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:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessage.Builder<Value.Builder>- Throws:
java.io.IOException
-
getKindCase
public Value.KindCase getKindCase()
- Specified by:
getKindCasein interfaceValueOrBuilder
-
clearKind
public Value.Builder clearKind()
-
getNullValueValue
public int getNullValueValue()
Represents a null value.
.google.protobuf.NullValue null_value = 1;- Specified by:
getNullValueValuein interfaceValueOrBuilder- Returns:
- The enum numeric value on the wire for nullValue.
-
setNullValueValue
public Value.Builder setNullValueValue(int value)
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
public NullValue getNullValue()
Represents a null value.
.google.protobuf.NullValue null_value = 1;- Specified by:
getNullValuein interfaceValueOrBuilder- Returns:
- The nullValue.
-
setNullValue
public Value.Builder setNullValue(NullValue value)
Represents a null value.
.google.protobuf.NullValue null_value = 1;- Parameters:
value- The nullValue to set.- Returns:
- This builder for chaining.
-
clearNullValue
public Value.Builder clearNullValue()
Represents a null value.
.google.protobuf.NullValue null_value = 1;- Returns:
- This builder for chaining.
-
getNumberValue
public double getNumberValue()
Represents a double value.
double number_value = 2;- Specified by:
getNumberValuein interfaceValueOrBuilder- Returns:
- The numberValue.
-
setNumberValue
public Value.Builder setNumberValue(double value)
Represents a double value.
double number_value = 2;- Parameters:
value- The numberValue to set.- Returns:
- This builder for chaining.
-
clearNumberValue
public Value.Builder clearNumberValue()
Represents a double value.
double number_value = 2;- Returns:
- This builder for chaining.
-
getStringValue
public java.lang.String getStringValue()
Represents a string value.
string string_value = 3;- Specified by:
getStringValuein interfaceValueOrBuilder- Returns:
- The stringValue.
-
getStringValueBytes
public ByteString getStringValueBytes()
Represents a string value.
string string_value = 3;- Specified by:
getStringValueBytesin interfaceValueOrBuilder- Returns:
- The bytes for stringValue.
-
setStringValue
public Value.Builder setStringValue(java.lang.String value)
Represents a string value.
string string_value = 3;- Parameters:
value- The stringValue to set.- Returns:
- This builder for chaining.
-
clearStringValue
public Value.Builder clearStringValue()
Represents a string value.
string string_value = 3;- Returns:
- This builder for chaining.
-
setStringValueBytes
public Value.Builder setStringValueBytes(ByteString value)
Represents a string value.
string string_value = 3;- Parameters:
value- The bytes for stringValue to set.- Returns:
- This builder for chaining.
-
getBoolValue
public boolean getBoolValue()
Represents a boolean value.
bool bool_value = 4;- Specified by:
getBoolValuein interfaceValueOrBuilder- Returns:
- The boolValue.
-
setBoolValue
public Value.Builder setBoolValue(boolean value)
Represents a boolean value.
bool bool_value = 4;- Parameters:
value- The boolValue to set.- Returns:
- This builder for chaining.
-
clearBoolValue
public Value.Builder 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:
hasStructValuein interfaceValueOrBuilder- Returns:
- Whether the structValue field is set.
-
getStructValue
public Struct getStructValue()
Represents a structured value.
.google.protobuf.Struct struct_value = 5;- Specified by:
getStructValuein interfaceValueOrBuilder- Returns:
- The structValue.
-
setStructValue
public Value.Builder setStructValue(Struct value)
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
setStructValue
public Value.Builder setStructValue(Struct.Builder builderForValue)
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
mergeStructValue
public Value.Builder mergeStructValue(Struct value)
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
clearStructValue
public Value.Builder clearStructValue()
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
getStructValueBuilder
public Struct.Builder getStructValueBuilder()
Represents a structured value.
.google.protobuf.Struct struct_value = 5;
-
getStructValueOrBuilder
public StructOrBuilder getStructValueOrBuilder()
Represents a structured value.
.google.protobuf.Struct struct_value = 5;- Specified by:
getStructValueOrBuilderin interfaceValueOrBuilder
-
hasListValue
public boolean hasListValue()
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;- Specified by:
hasListValuein interfaceValueOrBuilder- Returns:
- Whether the listValue field is set.
-
getListValue
public ListValue getListValue()
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;- Specified by:
getListValuein interfaceValueOrBuilder- Returns:
- The listValue.
-
setListValue
public Value.Builder setListValue(ListValue value)
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
setListValue
public Value.Builder setListValue(ListValue.Builder builderForValue)
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
mergeListValue
public Value.Builder mergeListValue(ListValue value)
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
clearListValue
public Value.Builder clearListValue()
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
getListValueBuilder
public ListValue.Builder getListValueBuilder()
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;
-
getListValueOrBuilder
public ListValueOrBuilder getListValueOrBuilder()
Represents a repeated `Value`.
.google.protobuf.ListValue list_value = 6;- Specified by:
getListValueOrBuilderin interfaceValueOrBuilder
-
setUnknownFields
public final Value.Builder setUnknownFields(UnknownFieldSet unknownFields)
Description copied from interface:Message.BuilderSet theUnknownFieldSetfor this message.- Specified by:
setUnknownFieldsin interfaceMessage.Builder- Overrides:
setUnknownFieldsin classGeneratedMessageV3.Builder<Value.Builder>
-
mergeUnknownFields
public final Value.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Description copied from interface:Message.BuilderMerge some unknown fields into theUnknownFieldSetfor this message.- Specified by:
mergeUnknownFieldsin interfaceMessage.Builder- Overrides:
mergeUnknownFieldsin classGeneratedMessageV3.Builder<Value.Builder>
-
-