public abstract static class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>> extends AbstractMessage.Builder<BuilderT>
GeneratedMessageV3
.Modifier | Constructor and Description |
---|---|
protected |
Builder() |
protected |
Builder(GeneratedMessageV3.BuilderParent builderParent) |
Modifier and Type | Method and Description |
---|---|
BuilderT |
addRepeatedField(Descriptors.FieldDescriptor field,
Object value)
Like
setRepeatedField , but appends the value as a new element. |
BuilderT |
clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their
builtin fields back to the initial values.
|
BuilderT |
clearField(Descriptors.FieldDescriptor field)
Clears the field.
|
BuilderT |
clearOneof(Descriptors.OneofDescriptor oneof)
TODO: Clear it when all subclasses have implemented this method.
|
BuilderT |
clone()
Clones the Builder.
|
Map<Descriptors.FieldDescriptor,Object> |
getAllFields()
Returns a collection of all the fields in this message which are set and their corresponding
values.
|
Descriptors.Descriptor |
getDescriptorForType()
Get the message's type's descriptor.
|
Object |
getField(Descriptors.FieldDescriptor field)
Obtains the value of the given field, or the default value if it is not set.
|
Message.Builder |
getFieldBuilder(Descriptors.FieldDescriptor field)
Get a nested builder instance for the given field.
|
Descriptors.FieldDescriptor |
getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)
TODO: Clear it when all subclasses have implemented this method.
|
protected GeneratedMessageV3.BuilderParent |
getParentForChildren()
Gets the
GeneratedMessageV3.BuilderParent for giving to our children. |
Object |
getRepeatedField(Descriptors.FieldDescriptor field,
int index)
Gets an element of a repeated field.
|
Message.Builder |
getRepeatedFieldBuilder(Descriptors.FieldDescriptor field,
int index)
Get a nested builder instance for the given repeated field instance.
|
int |
getRepeatedFieldCount(Descriptors.FieldDescriptor field)
Gets the number of elements of a repeated field.
|
UnknownFieldSet |
getUnknownFields()
Get the
UnknownFieldSet for this message. |
protected UnknownFieldSet.Builder |
getUnknownFieldSetBuilder() |
boolean |
hasField(Descriptors.FieldDescriptor field)
Returns true if the given field is set.
|
boolean |
hasOneof(Descriptors.OneofDescriptor oneof)
TODO: Clear it when all subclasses have implemented this method.
|
protected abstract GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.
|
protected MapField |
internalGetMapField(int fieldNumber)
Deprecated.
|
protected MapFieldReflectionAccessor |
internalGetMapFieldReflection(int fieldNumber)
Gets the map field with the given field number.
|
protected MapField |
internalGetMutableMapField(int fieldNumber)
Deprecated.
|
protected MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int fieldNumber)
Like
internalGetMapFieldReflection(int) but return a mutable version. |
protected boolean |
isClean()
Gets whether invalidations are needed
|
boolean |
isInitialized()
Returns true if all required fields in the message and all embedded messages are set, false
otherwise.
|
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.
|
BuilderT |
mergeUnknownFields(UnknownFieldSet unknownFields)
Merge some unknown fields into the
UnknownFieldSet for this message. |
protected void |
mergeUnknownLengthDelimitedField(int number,
ByteString bytes)
Called by generated subclasses to add to the unknown field set.
|
protected void |
mergeUnknownVarintField(int number,
int value)
Called by generated subclasses to add to the unknown field set.
|
Message.Builder |
newBuilderForField(Descriptors.FieldDescriptor field)
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 void |
onChanged()
Called when a 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.
|
BuilderT |
setField(Descriptors.FieldDescriptor field,
Object value)
Sets a field to the given value.
|
BuilderT |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
Object value)
Sets an element of a repeated field to the given value.
|
BuilderT |
setUnknownFields(UnknownFieldSet unknownFields)
Set the
UnknownFieldSet for this message. |
protected void |
setUnknownFieldSetBuilder(UnknownFieldSet.Builder builder) |
protected BuilderT |
setUnknownFieldsProto3(UnknownFieldSet unknownFields)
This method is obsolete, but we must retain it for compatibility with older generated code.
|
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
build, buildPartial, mergeDelimitedFrom, mergeDelimitedFrom
mergeFrom
getDefaultInstanceForType
protected Builder()
protected Builder(GeneratedMessageV3.BuilderParent builderParent)
protected void onBuilt()
protected void markClean()
protected boolean isClean()
public BuilderT clone()
MessageLite.Builder
clone
in interface Message.Builder
clone
in interface MessageLite.Builder
clone
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
Object.clone()
public BuilderT clear()
clear
in interface Message.Builder
clear
in interface MessageLite.Builder
clear
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
protected abstract GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
public Descriptors.Descriptor getDescriptorForType()
Message.Builder
MessageOrBuilder.getDescriptorForType()
.public Map<Descriptors.FieldDescriptor,Object> getAllFields()
MessageOrBuilder
MessageOrBuilder.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. public Message.Builder newBuilderForField(Descriptors.FieldDescriptor field)
Message.Builder
Message.Builder.setField(Descriptors.FieldDescriptor, Object)
,
Message.Builder.setRepeatedField(Descriptors.FieldDescriptor, int, Object)
, or
Message.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.
public Message.Builder getFieldBuilder(Descriptors.FieldDescriptor field)
Message.Builder
Normally, we hold a reference to the immutable message object for the message type field. Some implementations (the generated message builders) 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 is returned. Otherwise, a new field builder is created and returned. The original message field (if one exists) is merged into the field builder, which is then nested into its parent builder.
getFieldBuilder
in interface Message.Builder
getFieldBuilder
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
public Message.Builder getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)
Message.Builder
Normally, we hold a reference to the immutable message object for the message type field. Some implementations (the generated message builders) 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 is returned. Otherwise, a new field builder is created and returned. The original message field (if one exists) is merged into the field builder, which is then nested into its parent builder.
getRepeatedFieldBuilder
in interface Message.Builder
getRepeatedFieldBuilder
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
public boolean hasOneof(Descriptors.OneofDescriptor oneof)
AbstractMessage.Builder
hasOneof
in interface MessageOrBuilder
hasOneof
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
public Descriptors.FieldDescriptor getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)
AbstractMessage.Builder
getOneofFieldDescriptor
in interface MessageOrBuilder
getOneofFieldDescriptor
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
public boolean hasField(Descriptors.FieldDescriptor field)
MessageOrBuilder
public Object getField(Descriptors.FieldDescriptor field)
MessageOrBuilder
public BuilderT setField(Descriptors.FieldDescriptor field, Object value)
Message.Builder
MessageOrBuilder.getField(Descriptors.FieldDescriptor)
returns.public BuilderT clearField(Descriptors.FieldDescriptor field)
Message.Builder
public BuilderT clearOneof(Descriptors.OneofDescriptor oneof)
AbstractMessage.Builder
clearOneof
in interface Message.Builder
clearOneof
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
public int getRepeatedFieldCount(Descriptors.FieldDescriptor field)
MessageOrBuilder
public Object getRepeatedField(Descriptors.FieldDescriptor field, int index)
MessageOrBuilder
public BuilderT setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Message.Builder
MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
returns.public BuilderT addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Message.Builder
setRepeatedField
, but appends the value as a new element.public BuilderT setUnknownFields(UnknownFieldSet unknownFields)
Message.Builder
UnknownFieldSet
for this message.protected BuilderT setUnknownFieldsProto3(UnknownFieldSet unknownFields)
public BuilderT mergeUnknownFields(UnknownFieldSet unknownFields)
Message.Builder
UnknownFieldSet
for this message.mergeUnknownFields
in interface Message.Builder
mergeUnknownFields
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
public boolean isInitialized()
MessageLiteOrBuilder
public final UnknownFieldSet getUnknownFields()
MessageOrBuilder
UnknownFieldSet
for this message.protected boolean parseUnknownField(CodedInputStream input, ExtensionRegistryLite extensionRegistry, int tag) throws IOException
true
unless the tag is an end-group tag.IOException
protected final void mergeUnknownLengthDelimitedField(int number, ByteString bytes)
protected final void mergeUnknownVarintField(int number, int value)
protected UnknownFieldSet.Builder getUnknownFieldSetBuilder()
getUnknownFieldSetBuilder
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
protected void setUnknownFieldSetBuilder(UnknownFieldSet.Builder builder)
setUnknownFieldSetBuilder
in class AbstractMessage.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>
protected GeneratedMessageV3.BuilderParent getParentForChildren()
GeneratedMessageV3.BuilderParent
for giving to our children.protected final void onChanged()
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int fieldNumber)
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.
@Deprecated protected MapField internalGetMapField(int fieldNumber)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int fieldNumber)
internalGetMapFieldReflection(int)
but return a mutable version.@Deprecated protected MapField internalGetMutableMapField(int fieldNumber)
Copyright © 2008–2024. All rights reserved.