public abstract static class AbstractMessage.Builder<BuilderType extends AbstractMessage.Builder<BuilderType>> extends AbstractMessageLite.Builder implements Message.Builder
Message.Builder interface which
implements as many methods of that interface as possible in terms of
other methods.| Constructor and Description |
|---|
AbstractMessage.Builder() |
| Modifier and Type | Method and Description |
|---|---|
BuilderType |
clear()
Resets all fields to their default values.
|
BuilderType |
clearOneof(Descriptors.OneofDescriptor oneof)
TODO(jieluo): Clear it when all subclasses have implemented this method.
|
BuilderType |
clone()
Clones the Builder.
|
java.util.List<java.lang.String> |
findInitializationErrors()
Returns a list of field paths (e.g.
|
Message.Builder |
getFieldBuilder(Descriptors.FieldDescriptor field)
Get a nested builder instance for the given field.
|
java.lang.String |
getInitializationErrorString()
Returns a comma-delimited list of required fields which are not set
in this message object.
|
Descriptors.FieldDescriptor |
getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)
TODO(jieluo): Clear it when all subclasses have implemented this method.
|
Message.Builder |
getRepeatedFieldBuilder(Descriptors.FieldDescriptor field,
int index)
Get a nested builder instance for the given repeated field instance.
|
boolean |
hasOneof(Descriptors.OneofDescriptor oneof)
TODO(jieluo): Clear it when all subclasses have implemented this method.
|
protected BuilderType |
internalMergeFrom(AbstractMessageLite other) |
boolean |
mergeDelimitedFrom(java.io.InputStream input)
Like
MessageLite.Builder.mergeFrom(InputStream), but does not read until EOF. |
boolean |
mergeDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Like
MessageLite.Builder.mergeDelimitedFrom(InputStream) but supporting extensions. |
BuilderType |
mergeFrom(byte[] data)
Parse
data as a message of this type and merge it with the
message being built. |
BuilderType |
mergeFrom(byte[] data,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the
message being built. |
BuilderType |
mergeFrom(byte[] data,
int off,
int len)
Parse
data as a message of this type and merge it with the
message being built. |
BuilderType |
mergeFrom(byte[] data,
int off,
int len,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the
message being built. |
BuilderType |
mergeFrom(ByteString data)
Parse
data as a message of this type and merge it with the
message being built. |
BuilderType |
mergeFrom(ByteString data,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the
message being built. |
BuilderType |
mergeFrom(CodedInputStream input)
Parses a message of this type from the input and merges it with this
message.
|
BuilderType |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry)
Like
MessageLite.Builder.mergeFrom(CodedInputStream), but also
parses extensions. |
BuilderType |
mergeFrom(java.io.InputStream input)
Parse a message of this type from
input and merge it with the
message being built. |
BuilderType |
mergeFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Parse a message of this type from
input and merge it with the
message being built. |
BuilderType |
mergeFrom(Message other)
Merge
other into the message being built. |
BuilderType |
mergeUnknownFields(UnknownFieldSet unknownFields)
Merge some unknown fields into the
UnknownFieldSet for this
message. |
protected static UninitializedMessageException |
newUninitializedMessageException(Message message)
Construct an UninitializedMessageException reporting missing fields in
the given message.
|
java.lang.String |
toString() |
addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddRepeatedField, build, buildPartial, clearField, getDescriptorForType, newBuilderForField, setField, setRepeatedField, setUnknownFieldsmergeFromgetAllFields, getDefaultInstanceForType, getField, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasFieldisInitializedpublic BuilderType clone()
MessageLite.Builderclone in interface Message.Builderclone in interface MessageLite.Builderclone in class AbstractMessageLite.BuilderObject.clone()public boolean hasOneof(Descriptors.OneofDescriptor oneof)
hasOneof in interface MessageOrBuilderpublic Descriptors.FieldDescriptor getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)
getOneofFieldDescriptor in interface MessageOrBuilderpublic BuilderType clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.Builderpublic BuilderType clear()
MessageLite.Builderclear in interface Message.Builderclear in interface MessageLite.Builderpublic java.util.List<java.lang.String> findInitializationErrors()
MessageOrBuilderMessageLiteOrBuilder.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.findInitializationErrors in interface MessageOrBuilderpublic java.lang.String getInitializationErrorString()
MessageOrBuilderMessageLiteOrBuilder.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.getInitializationErrorString in interface MessageOrBuilderprotected BuilderType internalMergeFrom(AbstractMessageLite other)
internalMergeFrom in class AbstractMessageLite.Builderpublic BuilderType mergeFrom(Message other)
Message.Builderother into the message being built. other must
have the exact same type as this (i.e.
getDescriptorForType() == other.getDescriptorForType()).
Merging occurs as follows. For each field:other,
then other's value overwrites the value in this message.other,
it is merged into the corresponding sub-message of this message
using the same merging rules.other 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++.mergeFrom in interface Message.Builderpublic BuilderType mergeFrom(CodedInputStream input) throws java.io.IOException
MessageLite.BuilderWarning: This does not verify that all required fields are present in
the input message. If you call MessageLite.Builder.build() without setting all
required fields, it will throw an UninitializedMessageException,
which is a RuntimeException and thus might not be caught. There
are a few good ways to deal with this:
MessageLiteOrBuilder.isInitialized() to verify that all required fields
are set before building.
buildPartial() to build, which ignores missing
required fields.
Note: The caller should call
CodedInputStream.checkLastTagWas(int) after calling this to
verify that the last tag seen was the appropriate end-group tag,
or zero for EOF.
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.Builderjava.io.IOExceptionpublic BuilderType mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
MessageLite.BuilderMessageLite.Builder.mergeFrom(CodedInputStream), but also
parses extensions. The extensions that you want to be able to parse
must be registered in extensionRegistry. Extensions not in
the registry will be treated as unknown fields.mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.Builderjava.io.IOExceptionpublic BuilderType mergeUnknownFields(UnknownFieldSet unknownFields)
Message.BuilderUnknownFieldSet for this
message.mergeUnknownFields in interface Message.Builderpublic Message.Builder getFieldBuilder(Descriptors.FieldDescriptor field)
Message.BuilderNormally, 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.
getFieldBuilder in interface Message.Builderpublic Message.Builder getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)
Message.BuilderNormally, 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.
getRepeatedFieldBuilder in interface Message.Builderpublic java.lang.String toString()
toString in class java.lang.Objectprotected static UninitializedMessageException newUninitializedMessageException(Message message)
public BuilderType mergeFrom(ByteString data) throws InvalidProtocolBufferException
MessageLite.Builderdata as a message of this type and merge it with the
message being built. This is just a small wrapper around
MessageLite.Builder.mergeFrom(CodedInputStream).mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.BuilderInvalidProtocolBufferExceptionpublic BuilderType mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builderdata as a message of this type and merge it with the
message being built. This is just a small wrapper around
MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.BuilderInvalidProtocolBufferExceptionpublic BuilderType mergeFrom(byte[] data) throws InvalidProtocolBufferException
MessageLite.Builderdata as a message of this type and merge it with the
message being built. This is just a small wrapper around
MessageLite.Builder.mergeFrom(CodedInputStream).mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.BuilderInvalidProtocolBufferExceptionpublic BuilderType mergeFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException
MessageLite.Builderdata as a message of this type and merge it with the
message being built. This is just a small wrapper around
MessageLite.Builder.mergeFrom(CodedInputStream).mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.BuilderInvalidProtocolBufferExceptionpublic BuilderType mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builderdata as a message of this type and merge it with the
message being built. This is just a small wrapper around
MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.BuilderInvalidProtocolBufferExceptionpublic BuilderType mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builderdata as a message of this type and merge it with the
message being built. This is just a small wrapper around
MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.BuilderInvalidProtocolBufferExceptionpublic BuilderType mergeFrom(java.io.InputStream input) throws java.io.IOException
MessageLite.Builderinput and merge it with the
message being built. This is just a small wrapper around
MessageLite.Builder.mergeFrom(CodedInputStream). Note that this method always
reads the entire input (unless it throws an exception). If you
want it to stop earlier, you will need to wrap your input in some
wrapper stream that limits reading. Or, use
MessageLite.writeDelimitedTo(OutputStream) to write your message
and MessageLite.Builder.mergeDelimitedFrom(InputStream) to read it.
Despite usually reading the entire input, this does not close the stream.
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.Builderjava.io.IOExceptionpublic BuilderType mergeFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
MessageLite.Builderinput and merge it with the
message being built. This is just a small wrapper around
MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessageLite.Builderjava.io.IOExceptionpublic boolean mergeDelimitedFrom(java.io.InputStream input)
throws java.io.IOException
MessageLite.BuilderMessageLite.Builder.mergeFrom(InputStream), but does not read until EOF.
Instead, the size of the message (encoded as a varint) is read first,
then the message data. Use
MessageLite.writeDelimitedTo(OutputStream) to write messages in
this format.mergeDelimitedFrom in interface Message.BuildermergeDelimitedFrom in interface MessageLite.BuildermergeDelimitedFrom in class AbstractMessageLite.Builderjava.io.IOExceptionpublic boolean mergeDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
throws java.io.IOException
MessageLite.BuilderMessageLite.Builder.mergeDelimitedFrom(InputStream) but supporting extensions.mergeDelimitedFrom in interface Message.BuildermergeDelimitedFrom in interface MessageLite.BuildermergeDelimitedFrom in class AbstractMessageLite.Builderjava.io.IOException