Class AbstractMessage.Builder<BuilderType extends AbstractMessage.Builder<BuilderType>>
- All Implemented Interfaces:
Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,MessageOrBuilder
,Cloneable
- Direct Known Subclasses:
DynamicMessage.Builder
,GeneratedMessage.Builder
,MapEntry.Builder
- Enclosing class:
AbstractMessage
Message.Builder
interface which implements as many
methods of that interface as possible in terms of other methods.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclear()
TODO: Clear it when all subclasses have implemented this method.clone()
Returns a list of field paths (e.g.Get a nested builder instance for the given field.Returns a comma-delimited list of required fields which are not set in this message object.TODO: Clear it when all subclasses have implemented this method.getRepeatedFieldBuilder
(Descriptors.FieldDescriptor field, int index) Get a nested builder instance for the given repeated field instance.protected UnknownFieldSet.Builder
boolean
TODO: Clear it when all subclasses have implemented this method.protected BuilderType
internalMergeFrom
(com.google.protobuf.AbstractMessageLite other) mergeFrom
(byte[] data) mergeFrom
(byte[] data, int off, int len) mergeFrom
(byte[] data, int off, int len, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.ByteString data) mergeFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.CodedInputStream input) mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) Mergeother
into the message being built.mergeFrom
(InputStream input) mergeFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeUnknownFields
(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSet
for this message.protected static com.google.protobuf.UninitializedMessageException
newUninitializedMessageException
(Message message) Construct an UninitializedMessageException reporting missing fields in the given message.protected void
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
addRepeatedField, build, buildPartial, clearField, getDescriptorForType, mergeDelimitedFrom, mergeDelimitedFrom, newBuilderForField, setField, setRepeatedField, setUnknownFields
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
getAllFields, getDefaultInstanceForType, getField, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
clone
- Specified by:
clone
in interfaceMessage.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Specified by:
clone
in classcom.google.protobuf.AbstractMessageLite.Builder
-
hasOneof
TODO: Clear it when all subclasses have implemented this method.- Specified by:
hasOneof
in interfaceMessageOrBuilder
-
getOneofFieldDescriptor
TODO: Clear it when all subclasses have implemented this method.- Specified by:
getOneofFieldDescriptor
in interfaceMessageOrBuilder
-
clearOneof
TODO: Clear it when all subclasses have implemented this method.- Specified by:
clearOneof
in interfaceMessage.Builder
-
clear
- Specified by:
clear
in interfaceMessage.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
-
findInitializationErrors
Description copied from interface:MessageOrBuilder
Returns a list of field paths (e.g. "foo.bar.baz") of required fields which are not set in this message. You should callMessageLiteOrBuilder.isInitialized()
first to check if there are any missing fields, as that method is likely to be much faster than this one even when the message is fully-initialized.- Specified by:
findInitializationErrors
in interfaceMessageOrBuilder
-
getInitializationErrorString
Description copied from interface:MessageOrBuilder
Returns a comma-delimited list of required fields which are not set in this message object. You should callMessageLiteOrBuilder.isInitialized()
first to check if there are any missing fields, as that method is likely to be much faster than this one even when the message is fully-initialized.- Specified by:
getInitializationErrorString
in interfaceMessageOrBuilder
-
internalMergeFrom
- Specified by:
internalMergeFrom
in classcom.google.protobuf.AbstractMessageLite.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
-
mergeFrom
- Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
IOException
-
mergeFrom
public BuilderType mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Specified by:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
IOException
-
getUnknownFieldSetBuilder
-
setUnknownFieldSetBuilder
-
mergeUnknownFields
Description copied from interface:Message.Builder
Merge some unknown fields into theUnknownFieldSet
for this message.- Specified by:
mergeUnknownFields
in interfaceMessage.Builder
-
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) 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.
- Specified by:
getFieldBuilder
in interfaceMessage.Builder
-
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) 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.
- Specified by:
getRepeatedFieldBuilder
in interfaceMessage.Builder
-
toString
-
newUninitializedMessageException
protected static com.google.protobuf.UninitializedMessageException newUninitializedMessageException(Message message) Construct an UninitializedMessageException reporting missing fields in the given message. -
mergeFrom
public BuilderType mergeFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
mergeFrom
public BuilderType mergeFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
mergeFrom
- Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
mergeFrom
public BuilderType mergeFrom(byte[] data, int off, int len) throws com.google.protobuf.InvalidProtocolBufferException - Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
mergeFrom
public BuilderType mergeFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
mergeFrom
public BuilderType mergeFrom(byte[] data, int off, int len, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
mergeFrom
- Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
IOException
-
mergeFrom
public BuilderType mergeFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessageLite.Builder
- Throws:
IOException
-