public abstract static class AbstractMessage.Builder<BuilderType> extends AbstractMessageLite.Builder implements Message.Builder
A partial implementation of the Message.Builder interface which implements as many
methods of that interface as possible in terms of other methods.
Type Parameter
| Name | Description |
| BuilderType | |
Static Methods
newUninitializedMessageException(Message message)
protected static UninitializedMessageException newUninitializedMessageException(Message message)
Construct an UninitializedMessageException reporting missing fields in the given message.
Constructors
Builder()
Methods
clear()
public BuilderType clear()
Resets all fields to their default values.
| Type | Description |
| BuilderType | |
clearOneof(Descriptors.OneofDescriptor oneof)
public BuilderType clearOneof(Descriptors.OneofDescriptor oneof)
TODO(jieluo): Clear it when all subclasses have implemented this method.
| Type | Description |
| BuilderType | |
clone()
public BuilderType clone()
Returns
| Type | Description |
| BuilderType | |
Overrides
findInitializationErrors()
public List<String> findInitializationErrors()
Returns a list of field paths (e.g. "foo.bar.baz") of required fields which are not set in this
message. You should call MessageLiteOrBuilder#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.
getFieldBuilder(Descriptors.FieldDescriptor field)
public Message.Builder getFieldBuilder(Descriptors.FieldDescriptor field)
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.
getInitializationErrorString()
public String getInitializationErrorString()
Returns a comma-delimited list of required fields which are not set in this message object. You
should call MessageLiteOrBuilder#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.
getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)
public Descriptors.FieldDescriptor getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)
TODO(jieluo): Clear it when all subclasses have implemented this method.
getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)
public Message.Builder getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)
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.
hasOneof(Descriptors.OneofDescriptor oneof)
public boolean hasOneof(Descriptors.OneofDescriptor oneof)
TODO(jieluo): Clear it when all subclasses have implemented this method.
internalMergeFrom(AbstractMessageLite other)
protected BuilderType internalMergeFrom(AbstractMessageLite other)
Parameter
Returns
| Type | Description |
| BuilderType | |
Overrides
public boolean mergeDelimitedFrom(InputStream input)
Parameter
Returns
Overrides
Exceptions
public boolean mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(byte[] data)
public BuilderType mergeFrom(byte[] data)
Parse data as a message of this type and merge it with the message being built. This
is just a small wrapper around #mergeFrom(CodedInputStream).
| Name | Description |
| data | byte[]
|
Returns
| Type | Description |
| BuilderType | |
Overrides
Exceptions
mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public BuilderType mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
| Type | Description |
| BuilderType | |
Overrides
Exceptions
mergeFrom(byte[] data, int off, int len)
public BuilderType mergeFrom(byte[] data, int off, int len)
Parse data as a message of this type and merge it with the message being built. This
is just a small wrapper around #mergeFrom(CodedInputStream).
| Type | Description |
| BuilderType | |
Overrides
Exceptions
mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)
public BuilderType mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
| Type | Description |
| BuilderType | |
Overrides
Exceptions
mergeFrom(ByteString data)
public BuilderType mergeFrom(ByteString data)
Parse data as a message of this type and merge it with the message being built. This
is just a small wrapper around #mergeFrom(CodedInputStream).
| Type | Description |
| BuilderType | |
Overrides
Exceptions
mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public BuilderType mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
| Type | Description |
| BuilderType | |
Overrides
Exceptions
public BuilderType mergeFrom(CodedInputStream input)
Parses a message of this type from the input and merges it with this message.
Warning: This does not verify that all required fields are present in the input message.
If you call #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:
- Call #isInitialized() to verify that all required fields are set before
building.
- Use
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.
| Type | Description |
| BuilderType | |
Overrides
Exceptions
public BuilderType mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Like 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.
| Type | Description |
| BuilderType | |
Overrides
Exceptions
mergeFrom(Message other)
public BuilderType mergeFrom(Message other)
Merge other 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:
- For singular primitive fields, if the field is set in
other, then other's
value overwrites the value in this message.
- For singular message fields, if the field is set in
other, it is merged into the
corresponding sub-message of this message using the same merging rules.
- For repeated fields, the elements in
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++.
| Type | Description |
| BuilderType | |
public BuilderType mergeFrom(InputStream input)
Parse a message of this type from input and merge it with the message being built.
This is just a small wrapper around #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 #mergeDelimitedFrom(InputStream) to read it.
Despite usually reading the entire input, this does not close the stream.
| Type | Description |
| BuilderType | |
Overrides
Exceptions
public BuilderType mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
| Type | Description |
| BuilderType | |
Overrides
Exceptions
mergeUnknownFields(UnknownFieldSet unknownFields)
public BuilderType mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
| Type | Description |
| BuilderType | |
toString()
Returns
Overrides
