Package com.google.protobuf
Class Value.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- 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
Protobuf typegoogle.protobuf.Value
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Value.Builder
addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
LikesetRepeatedField
, but appends the value as a new element.Value
build()
Constructs the message based on the state of the Builder.Value
buildPartial()
LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields.Value.Builder
clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.Value.Builder
clearBoolValue()
bool bool_value = 4 [json_name = "boolValue"];
Value.Builder
clearField(Descriptors.FieldDescriptor field)
Clears the field.Value.Builder
clearKind()
Value.Builder
clearListValue()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
Value.Builder
clearNullValue()
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
Value.Builder
clearNumberValue()
double number_value = 2 [json_name = "numberValue"];
Value.Builder
clearOneof(Descriptors.OneofDescriptor oneof)
TODO: Clear it when all subclasses have implemented this method.Value.Builder
clearStringValue()
string string_value = 3 [json_name = "stringValue"];
Value.Builder
clearStructValue()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
Value.Builder
clone()
Clones the Builder.boolean
getBoolValue()
bool bool_value = 4 [json_name = "boolValue"];
Value
getDefaultInstanceForType()
Get an instance of the type with no fields set.static Descriptors.Descriptor
getDescriptor()
Descriptors.Descriptor
getDescriptorForType()
Get the message's type's descriptor.Value.KindCase
getKindCase()
ListValue
getListValue()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
ListValue.Builder
getListValueBuilder()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
ListValueOrBuilder
getListValueOrBuilder()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
NullValue
getNullValue()
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
int
getNullValueValue()
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
double
getNumberValue()
double number_value = 2 [json_name = "numberValue"];
java.lang.String
getStringValue()
string string_value = 3 [json_name = "stringValue"];
ByteString
getStringValueBytes()
string string_value = 3 [json_name = "stringValue"];
Struct
getStructValue()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
Struct.Builder
getStructValueBuilder()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
StructOrBuilder
getStructValueOrBuilder()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
boolean
hasBoolValue()
bool bool_value = 4 [json_name = "boolValue"];
boolean
hasListValue()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
boolean
hasNullValue()
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
boolean
hasNumberValue()
double number_value = 2 [json_name = "numberValue"];
boolean
hasStringValue()
string string_value = 3 [json_name = "stringValue"];
boolean
hasStructValue()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
protected GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.boolean
isInitialized()
Returns true if all required fields in the message and all embedded messages are set, false otherwise.Value.Builder
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions.Value.Builder
mergeFrom(Message other)
Mergeother
into the message being built.Value.Builder
mergeFrom(Value other)
Value.Builder
mergeListValue(ListValue value)
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
Value.Builder
mergeStructValue(Struct value)
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
Value.Builder
mergeUnknownFields(UnknownFieldSet unknownFields)
Merge some unknown fields into theUnknownFieldSet
for this message.Value.Builder
setBoolValue(boolean value)
bool bool_value = 4 [json_name = "boolValue"];
Value.Builder
setField(Descriptors.FieldDescriptor field, java.lang.Object value)
Sets a field to the given value.Value.Builder
setListValue(ListValue value)
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
Value.Builder
setListValue(ListValue.Builder builderForValue)
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
Value.Builder
setNullValue(NullValue value)
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
Value.Builder
setNullValueValue(int value)
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
Value.Builder
setNumberValue(double value)
double number_value = 2 [json_name = "numberValue"];
Value.Builder
setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Sets an element of a repeated field to the given value.Value.Builder
setStringValue(java.lang.String value)
string string_value = 3 [json_name = "stringValue"];
Value.Builder
setStringValueBytes(ByteString value)
string string_value = 3 [json_name = "stringValue"];
Value.Builder
setStructValue(Struct value)
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
Value.Builder
setStructValue(Struct.Builder builderForValue)
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
Value.Builder
setUnknownFields(UnknownFieldSet unknownFields)
Set theUnknownFieldSet
for this message.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
-
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.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
public 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
public Descriptors.Descriptor 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
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 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
public Value 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
public Value 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
public Value.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:
Object.clone()
-
setField
public Value.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
Description copied from interface:Message.Builder
Sets a field to the given value. The value must be of the correct type for this field, that is, the same type thatMessageOrBuilder.getField(Descriptors.FieldDescriptor)
returns.- Specified by:
setField
in interfaceMessage.Builder
- Overrides:
setField
in classGeneratedMessageV3.Builder<Value.Builder>
-
clearField
public Value.Builder clearField(Descriptors.FieldDescriptor field)
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
public Value.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Description copied from class:AbstractMessage.Builder
TODO: Clear it when all subclasses have implemented this method.- Specified by:
clearOneof
in interfaceMessage.Builder
- Overrides:
clearOneof
in classGeneratedMessageV3.Builder<Value.Builder>
-
setRepeatedField
public Value.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
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; that is, the same type thatMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
returns.- Specified by:
setRepeatedField
in interfaceMessage.Builder
- Overrides:
setRepeatedField
in classGeneratedMessageV3.Builder<Value.Builder>
-
addRepeatedField
public Value.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
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
public Value.Builder mergeFrom(Message other)
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
public Value.Builder mergeFrom(Value other)
-
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 java.io.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:
InvalidProtocolBufferException
- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.java.io.IOException
- an I/O error reading from the stream
-
getKindCase
public Value.KindCase getKindCase()
- Specified by:
getKindCase
in interfaceValueOrBuilder
-
clearKind
public Value.Builder clearKind()
-
hasNullValue
public boolean hasNullValue()
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
- Specified by:
hasNullValue
in interfaceValueOrBuilder
- Returns:
- Whether the nullValue field is set.
-
getNullValueValue
public int getNullValueValue()
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
- Specified by:
getNullValueValue
in interfaceValueOrBuilder
- Returns:
- The enum numeric value on the wire for nullValue.
-
setNullValueValue
public Value.Builder setNullValueValue(int value)
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
- Parameters:
value
- The enum numeric value on the wire for nullValue to set.- Returns:
- This builder for chaining.
-
getNullValue
public NullValue getNullValue()
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
- Specified by:
getNullValue
in interfaceValueOrBuilder
- Returns:
- The nullValue.
-
setNullValue
public Value.Builder setNullValue(NullValue value)
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
- Parameters:
value
- The nullValue to set.- Returns:
- This builder for chaining.
-
clearNullValue
public Value.Builder clearNullValue()
.google.protobuf.NullValue null_value = 1 [json_name = "nullValue"];
- Returns:
- This builder for chaining.
-
hasNumberValue
public boolean hasNumberValue()
double number_value = 2 [json_name = "numberValue"];
- Specified by:
hasNumberValue
in interfaceValueOrBuilder
- Returns:
- Whether the numberValue field is set.
-
getNumberValue
public double getNumberValue()
double number_value = 2 [json_name = "numberValue"];
- Specified by:
getNumberValue
in interfaceValueOrBuilder
- Returns:
- The numberValue.
-
setNumberValue
public Value.Builder setNumberValue(double value)
double number_value = 2 [json_name = "numberValue"];
- Parameters:
value
- The numberValue to set.- Returns:
- This builder for chaining.
-
clearNumberValue
public Value.Builder clearNumberValue()
double number_value = 2 [json_name = "numberValue"];
- Returns:
- This builder for chaining.
-
hasStringValue
public boolean hasStringValue()
string string_value = 3 [json_name = "stringValue"];
- Specified by:
hasStringValue
in interfaceValueOrBuilder
- Returns:
- Whether the stringValue field is set.
-
getStringValue
public java.lang.String getStringValue()
string string_value = 3 [json_name = "stringValue"];
- Specified by:
getStringValue
in interfaceValueOrBuilder
- Returns:
- The stringValue.
-
getStringValueBytes
public ByteString getStringValueBytes()
string string_value = 3 [json_name = "stringValue"];
- Specified by:
getStringValueBytes
in interfaceValueOrBuilder
- Returns:
- The bytes for stringValue.
-
setStringValue
public Value.Builder setStringValue(java.lang.String value)
string string_value = 3 [json_name = "stringValue"];
- Parameters:
value
- The stringValue to set.- Returns:
- This builder for chaining.
-
clearStringValue
public Value.Builder clearStringValue()
string string_value = 3 [json_name = "stringValue"];
- Returns:
- This builder for chaining.
-
setStringValueBytes
public Value.Builder setStringValueBytes(ByteString value)
string string_value = 3 [json_name = "stringValue"];
- Parameters:
value
- The bytes for stringValue to set.- Returns:
- This builder for chaining.
-
hasBoolValue
public boolean hasBoolValue()
bool bool_value = 4 [json_name = "boolValue"];
- Specified by:
hasBoolValue
in interfaceValueOrBuilder
- Returns:
- Whether the boolValue field is set.
-
getBoolValue
public boolean getBoolValue()
bool bool_value = 4 [json_name = "boolValue"];
- Specified by:
getBoolValue
in interfaceValueOrBuilder
- Returns:
- The boolValue.
-
setBoolValue
public Value.Builder setBoolValue(boolean value)
bool bool_value = 4 [json_name = "boolValue"];
- Parameters:
value
- The boolValue to set.- Returns:
- This builder for chaining.
-
clearBoolValue
public Value.Builder clearBoolValue()
bool bool_value = 4 [json_name = "boolValue"];
- Returns:
- This builder for chaining.
-
hasStructValue
public boolean hasStructValue()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
- Specified by:
hasStructValue
in interfaceValueOrBuilder
- Returns:
- Whether the structValue field is set.
-
getStructValue
public Struct getStructValue()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
- Specified by:
getStructValue
in interfaceValueOrBuilder
- Returns:
- The structValue.
-
setStructValue
public Value.Builder setStructValue(Struct value)
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
-
setStructValue
public Value.Builder setStructValue(Struct.Builder builderForValue)
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
-
mergeStructValue
public Value.Builder mergeStructValue(Struct value)
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
-
clearStructValue
public Value.Builder clearStructValue()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
-
getStructValueBuilder
public Struct.Builder getStructValueBuilder()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
-
getStructValueOrBuilder
public StructOrBuilder getStructValueOrBuilder()
.google.protobuf.Struct struct_value = 5 [json_name = "structValue"];
- Specified by:
getStructValueOrBuilder
in interfaceValueOrBuilder
-
hasListValue
public boolean hasListValue()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
- Specified by:
hasListValue
in interfaceValueOrBuilder
- Returns:
- Whether the listValue field is set.
-
getListValue
public ListValue getListValue()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
- Specified by:
getListValue
in interfaceValueOrBuilder
- Returns:
- The listValue.
-
setListValue
public Value.Builder setListValue(ListValue value)
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
-
setListValue
public Value.Builder setListValue(ListValue.Builder builderForValue)
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
-
mergeListValue
public Value.Builder mergeListValue(ListValue value)
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
-
clearListValue
public Value.Builder clearListValue()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
-
getListValueBuilder
public ListValue.Builder getListValueBuilder()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
-
getListValueOrBuilder
public ListValueOrBuilder getListValueOrBuilder()
.google.protobuf.ListValue list_value = 6 [json_name = "listValue"];
- Specified by:
getListValueOrBuilder
in interfaceValueOrBuilder
-
setUnknownFields
public final Value.Builder setUnknownFields(UnknownFieldSet unknownFields)
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
public final Value.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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>
-
-