public static interface Message.Builder extends MessageLite.Builder, MessageOrBuilder
Abstract interface implemented by Protocol Message builders.
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public abstract Message.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Like setRepeatedField, but appends the value as a new element.
build()
public abstract Message build()
Constructs the message based on the state of the Builder. Subsequent changes to the Builder
will not affect the returned message.
buildPartial()
public abstract Message buildPartial()
Like #build(), but does not throw an exception if the message is missing required
fields. Instead, a partial message is returned. Subsequent changes to the Builder will not
affect the returned message.
clear()
public abstract Message.Builder clear()
Resets all fields to their default values.
clearField(Descriptors.FieldDescriptor field)
public abstract Message.Builder clearField(Descriptors.FieldDescriptor field)
Clears the field. This is exactly equivalent to calling the generated "clear" accessor method
corresponding to the field.
clearOneof(Descriptors.OneofDescriptor oneof)
public abstract Message.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Clears the oneof. This is exactly equivalent to calling the generated "clear" accessor method
corresponding to the oneof.
clone()
public abstract Message.Builder clone()
getDescriptorForType()
public abstract Descriptors.Descriptor getDescriptorForType()
Get the message's type's descriptor. See Message#getDescriptorForType().
getFieldBuilder(Descriptors.FieldDescriptor field)
public abstract 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.
getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)
public abstract 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.
public abstract boolean mergeDelimitedFrom(InputStream input)
public abstract boolean mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
mergeFrom(byte[] data)
public abstract Message.Builder 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).
| Parameter |
|---|
| Name | Description |
data | byte[]
|
mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public abstract Message.Builder mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
mergeFrom(byte[] data, int off, int len)
public abstract Message.Builder 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).
mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)
public abstract Message.Builder mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)
mergeFrom(ByteString data)
public abstract Message.Builder 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).
mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public abstract Message.Builder mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public abstract Message.Builder 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.
public abstract Message.Builder 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.
mergeFrom(Message other)
public abstract Message.Builder 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++.
| Parameter |
|---|
| Name | Description |
other | Message
|
public abstract Message.Builder 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.
public abstract Message.Builder mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
mergeUnknownFields(UnknownFieldSet unknownFields)
public abstract Message.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
newBuilderForField(Descriptors.FieldDescriptor field)
public abstract Message.Builder newBuilderForField(Descriptors.FieldDescriptor field)
setField(Descriptors.FieldDescriptor field, Object value)
public abstract Message.Builder setField(Descriptors.FieldDescriptor field, Object value)
Sets a field to the given value. The value must be of the correct type for this field, i.e.
the same type that Message#getField(Descriptors.FieldDescriptor) would return.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public abstract Message.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
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 that Message#getRepeatedField(Descriptors.FieldDescriptor,int) would return.
setUnknownFields(UnknownFieldSet unknownFields)
public abstract Message.Builder setUnknownFields(UnknownFieldSet unknownFields)
