Class GeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
- All Implemented Interfaces:
Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,Cloneable
- Direct Known Subclasses:
Any.Builder
,Api.Builder
,BoolValue.Builder
,BytesValue.Builder
,DescriptorProtos.DescriptorProto.Builder
,DescriptorProtos.DescriptorProto.ExtensionRange.Builder
,DescriptorProtos.DescriptorProto.ReservedRange.Builder
,DescriptorProtos.EnumDescriptorProto.Builder
,DescriptorProtos.EnumDescriptorProto.EnumReservedRange.Builder
,DescriptorProtos.EnumValueDescriptorProto.Builder
,DescriptorProtos.FieldDescriptorProto.Builder
,DescriptorProtos.FileDescriptorProto.Builder
,DescriptorProtos.FileDescriptorSet.Builder
,DescriptorProtos.GeneratedCodeInfo.Annotation.Builder
,DescriptorProtos.GeneratedCodeInfo.Builder
,DescriptorProtos.MethodDescriptorProto.Builder
,DescriptorProtos.OneofDescriptorProto.Builder
,DescriptorProtos.ServiceDescriptorProto.Builder
,DescriptorProtos.SourceCodeInfo.Builder
,DescriptorProtos.SourceCodeInfo.Location.Builder
,DescriptorProtos.UninterpretedOption.Builder
,DescriptorProtos.UninterpretedOption.NamePart.Builder
,DoubleValue.Builder
,Duration.Builder
,Empty.Builder
,Enum.Builder
,EnumValue.Builder
,Field.Builder
,FieldMask.Builder
,FloatValue.Builder
,GeneratedMessageV3.ExtendableBuilder
,Int32Value.Builder
,Int64Value.Builder
,ListValue.Builder
,Method.Builder
,Mixin.Builder
,Option.Builder
,PluginProtos.CodeGeneratorRequest.Builder
,PluginProtos.CodeGeneratorResponse.Builder
,PluginProtos.CodeGeneratorResponse.File.Builder
,PluginProtos.Version.Builder
,SourceContext.Builder
,StringValue.Builder
,Struct.Builder
,Timestamp.Builder
,Type.Builder
,UInt32Value.Builder
,UInt64Value.Builder
,Value.Builder
- Enclosing class:
GeneratedMessageV3
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
Implementation ofGeneratedMessageV3.BuilderParent
for giving to our children.Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate GeneratedMessageV3.BuilderParent
private boolean
private Object
This field holds either anUnknownFieldSet
orUnknownFieldSet.Builder
. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Builder()
protected
Builder
(GeneratedMessageV3.BuilderParent builderParent) -
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(Descriptors.FieldDescriptor field, Object value) LikesetRepeatedField
, but appends the value as a new element.clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.Clears the field.TODO(jieluo): Clear it when all subclasses have implemented this method.clone()
Clones the Builder.(package private) void
dispose()
Used to support nested builders and called when this nested builder is no longer used by its parent builder and should release the reference to its parent builder.Returns a collection of all the fields in this message which are set and their corresponding values.private Map
<Descriptors.FieldDescriptor, Object> Internal helper which returns a mutable map.Get the message's type's descriptor.Obtains the value of the given field, or the default value if it is not set.Get a nested builder instance for the given field.TODO(jieluo): Clear it when all subclasses have implemented this method.protected GeneratedMessageV3.BuilderParent
Gets theGeneratedMessageV3.BuilderParent
for giving to our children.getRepeatedField
(Descriptors.FieldDescriptor field, int index) Gets an element of a repeated field.getRepeatedFieldBuilder
(Descriptors.FieldDescriptor field, int index) Get a nested builder instance for the given repeated field instance.int
Gets the number of elements of a repeated field.final UnknownFieldSet
Get theUnknownFieldSet
for this message.protected UnknownFieldSet.Builder
boolean
Returns true if the given field is set.boolean
TODO(jieluo): Clear it when all subclasses have implemented this method.protected abstract GeneratedMessageV3.FieldAccessorTable
Get the FieldAccessorTable for this type.protected MapField
internalGetMapField
(int fieldNumber) Gets the map field with the given field number.protected MapField
internalGetMutableMapField
(int fieldNumber) LikeinternalGetMapField(int)
but return a mutable version.protected boolean
isClean()
Gets whether invalidations are neededboolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.protected void
Called by the subclass or a builder to notify us that a message was built and may be cached and therefore invalidations are needed.mergeUnknownFields
(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSet
for this message.protected final void
mergeUnknownLengthDelimitedField
(int number, ByteString bytes) Called by generated subclasses to add to the unknown field set.protected final void
mergeUnknownVarintField
(int number, int value) Called by generated subclasses to add to the unknown field set.Create a builder for messages of the appropriate type for the given field.protected void
onBuilt()
Called by the subclass when a message is built.protected final void
Called when a the builder or one of its nested children has changed and any parent should be notified of its invalidation.protected boolean
parseUnknownField
(CodedInputStream input, ExtensionRegistryLite extensionRegistry, int tag) Called by generated subclasses to parse an unknown field.setField
(Descriptors.FieldDescriptor field, Object value) Sets a field to the given value.setRepeatedField
(Descriptors.FieldDescriptor field, int index, Object value) Sets an element of a repeated field to the given value.setUnknownFields
(UnknownFieldSet unknownFields) Set theUnknownFieldSet
for this message.protected void
private BuilderType
setUnknownFieldsInternal
(UnknownFieldSet unknownFields) protected BuilderType
setUnknownFieldsProto3
(UnknownFieldSet unknownFields) This method is obsolete, but we must retain it for compatibility with older generated code.Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, 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.Message.Builder
build, buildPartial
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
getDefaultInstanceForType
-
Field Details
-
builderParent
-
meAsParent
private GeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>.BuilderParentImpl meAsParent -
isClean
private boolean isClean -
unknownFieldsOrBuilder
This field holds either anUnknownFieldSet
orUnknownFieldSet.Builder
.We use an object because it should only be one or the other of those things at a time and Object is the only common base. This also saves space.
Conversions are lazy: if
setUnknownFields(com.google.protobuf.UnknownFieldSet)
is called, this will containUnknownFieldSet
. If unknown fields are merged into this builder, the currentUnknownFieldSet
will be converted to aUnknownFieldSet.Builder
and left that way until eithersetUnknownFields(com.google.protobuf.UnknownFieldSet)
orMessageLite.Builder.buildPartial()
orMessageLite.Builder.build()
is called.
-
-
Constructor Details
-
Builder
protected Builder() -
Builder
-
-
Method Details
-
dispose
void dispose()Description copied from class:AbstractMessage.Builder
Used to support nested builders and called when this nested builder is no longer used by its parent builder and should release the reference to its parent builder.NOTE: Implementations that don't support nested builders don't need to override this method.
- Overrides:
dispose
in classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
onBuilt
protected void onBuilt()Called by the subclass when a message is built. -
markClean
protected void markClean()Called by the subclass or a builder to notify us that a message was built and may be cached and therefore invalidations are needed.- Overrides:
markClean
in classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
isClean
protected boolean isClean()Gets whether invalidations are needed- Returns:
- whether invalidations are needed
-
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 classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
- See Also:
-
clear
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 classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
internalGetFieldAccessorTable
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. -
getDescriptorForType
Description copied from interface:Message.Builder
Get the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType()
. -
getAllFields
Description copied from interface:MessageOrBuilder
Returns a collection of all the fields in this message which are set and their corresponding values. A singular ("required" or "optional") field is set iff hasField() returns true for that field. A "repeated" field is set iff getRepeatedFieldCount() is greater than zero. The values are exactly what would be returned by callingMessageOrBuilder.getField(Descriptors.FieldDescriptor)
for each field. The map is guaranteed to be a sorted map, so iterating over it will return fields in order by field number.
If this is for a builder, the returned map may or may not reflect future changes to the builder. Either way, the returned map is itself unmodifiable. -
getAllFieldsMutable
Internal helper which returns a mutable map. -
newBuilderForField
Description copied from interface:Message.Builder
Create a builder for messages of the appropriate type for the given field. The builder is NOT nested in the current builder. However, messages built with the builder can then be passed to theMessage.Builder.setField(Descriptors.FieldDescriptor, Object)
,Message.Builder.setRepeatedField(Descriptors.FieldDescriptor, int, Object)
, orMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor, Object)
method of the current builder.To obtain a builder nested in the current builder, use
Message.Builder.getFieldBuilder(Descriptors.FieldDescriptor)
instead. -
getFieldBuilder
Description copied from interface:Message.Builder
Get a nested builder instance for the given field.Normally, we hold a reference to the immutable message object for the message type field. Some implementations(the generated message builders), however, can also hold a reference to the builder object (a nested builder) for the field.
If the field is already backed up by a nested builder, the nested builder will be returned. Otherwise, a new field builder will be created and returned. The original message field (if exist) will be merged into the field builder, which will then be nested into its parent builder.
NOTE: implementations that do not support nested builders will throw
UnsupportedOperationException
.- Specified by:
getFieldBuilder
in interfaceMessage.Builder
- Overrides:
getFieldBuilder
in classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
getRepeatedFieldBuilder
Description copied from interface:Message.Builder
Get a nested builder instance for the given repeated field instance.Normally, we hold a reference to the immutable message object for the message type field. Some implementations(the generated message builders), however, can also hold a reference to the builder object (a nested builder) for the field.
If the field is already backed up by a nested builder, the nested builder will be returned. Otherwise, a new field builder will be created and returned. The original message field (if exist) will be merged into the field builder, which will then be nested into its parent builder.
NOTE: implementations that do not support nested builders will throw
UnsupportedOperationException
.- Specified by:
getRepeatedFieldBuilder
in interfaceMessage.Builder
- Overrides:
getRepeatedFieldBuilder
in classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
hasOneof
Description copied from class:AbstractMessage.Builder
TODO(jieluo): Clear it when all subclasses have implemented this method.- Specified by:
hasOneof
in interfaceMessageOrBuilder
- Overrides:
hasOneof
in classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
getOneofFieldDescriptor
Description copied from class:AbstractMessage.Builder
TODO(jieluo): Clear it when all subclasses have implemented this method.- Specified by:
getOneofFieldDescriptor
in interfaceMessageOrBuilder
- Overrides:
getOneofFieldDescriptor
in classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
hasField
Description copied from interface:MessageOrBuilder
Returns true if the given field is set. This is exactly equivalent to calling the generated "has" accessor method corresponding to the field. -
getField
Description copied from interface:MessageOrBuilder
Obtains the value of the given field, or the default value if it is not set. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned. For repeated fields, a java.util.List is returned. -
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. -
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. -
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 classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
getRepeatedFieldCount
Description copied from interface:MessageOrBuilder
Gets the number of elements of a repeated field. This is exactly equivalent to calling the generated "Count" accessor method corresponding to the field. -
getRepeatedField
Description copied from interface:MessageOrBuilder
Gets an element of a repeated field. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned. -
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. -
addRepeatedField
Description copied from interface:Message.Builder
LikesetRepeatedField
, but appends the value as a new element. -
setUnknownFieldsInternal
-
setUnknownFields
Description copied from interface:Message.Builder
Set theUnknownFieldSet
for this message. -
setUnknownFieldsProto3
This method is obsolete, but we must retain it for compatibility with older generated code. -
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 classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
isInitialized
public boolean isInitialized()Description copied from interface:MessageLiteOrBuilder
Returns true if all required fields in the message and all embedded messages are set, false otherwise. -
getUnknownFields
Description copied from interface:MessageOrBuilder
Get theUnknownFieldSet
for this message. -
parseUnknownField
protected boolean parseUnknownField(CodedInputStream input, ExtensionRegistryLite extensionRegistry, int tag) throws IOException Called by generated subclasses to parse an unknown field.- Returns:
true
unless the tag is an end-group tag.- Throws:
IOException
-
mergeUnknownLengthDelimitedField
Called by generated subclasses to add to the unknown field set. -
mergeUnknownVarintField
protected final void mergeUnknownVarintField(int number, int value) Called by generated subclasses to add to the unknown field set. -
getUnknownFieldSetBuilder
- Overrides:
getUnknownFieldSetBuilder
in classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
setUnknownFieldSetBuilder
- Overrides:
setUnknownFieldSetBuilder
in classAbstractMessage.Builder<BuilderType extends GeneratedMessageV3.Builder<BuilderType>>
-
getParentForChildren
Gets theGeneratedMessageV3.BuilderParent
for giving to our children.- Returns:
- The builder parent for our children.
-
onChanged
protected final void onChanged()Called when a the builder or one of its nested children has changed and any parent should be notified of its invalidation. -
internalGetMapField
Gets the map field with the given field number. This method should be overridden in the generated message class if the message contains map fields. Unlike other field types, reflection support for map fields can't be implemented based on generated public API because we need to access a map field as a list in reflection API but the generated API only allows us to access it as a map. This method returns the underlying map field directly and thus enables us to access the map field as a list. -
internalGetMutableMapField
LikeinternalGetMapField(int)
but return a mutable version.
-