public abstract static class AbstractMessageLite.Builder<MessageType,BuilderType> implements MessageLite.Builder
A partial implementation of the Message.Builder interface which implements as many
methods of that interface as possible in terms of other methods.
Inheritance
java.lang.Object >
AbstractMessageLite.Builder<MessageType,BuilderType>
Type Parameters
Name | Description |
MessageType | |
BuilderType | |
Static Methods
<T>addAll(Iterable<T> values, Collection<? super T> list)
protected static void <T>addAll(Iterable<T> values, Collection<? super T> list)
Parameters
<T>addAll(Iterable<T> values, List<? super T> list)
protected static void <T>addAll(Iterable<T> values, List<? super T> list)
Adds the values
to the list
. This is a helper method used by generated code.
Users should ignore it.
Parameters
newUninitializedMessageException(MessageLite message)
protected static UninitializedMessageException newUninitializedMessageException(MessageLite message)
Construct an UninitializedMessageException reporting missing fields in the given message.
Parameter
Returns
Constructors
Builder()
Methods
clone()
public abstract BuilderType clone()
Returns
Type | Description |
BuilderType | |
Overrides
internalMergeFrom(MessageType message)
protected abstract BuilderType internalMergeFrom(MessageType message)
Parameter
Name | Description |
message | MessageType
|
Returns
Type | Description |
BuilderType | |
public boolean mergeDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public boolean mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
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).
Parameter
Name | Description |
data | byte[]
|
Returns
Type | Description |
BuilderType | |
Exceptions
mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public BuilderType mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Type | Description |
BuilderType | |
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).
Parameters
Returns
Type | Description |
BuilderType | |
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 | |
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).
Parameter
Returns
Type | Description |
BuilderType | |
Exceptions
mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public BuilderType mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Type | Description |
BuilderType | |
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.
Parameter
Returns
Type | Description |
BuilderType | |
Exceptions
public abstract 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.
Parameters
Returns
Type | Description |
BuilderType | |
Exceptions
mergeFrom(MessageLite other)
public BuilderType mergeFrom(MessageLite other)
Merge other
into the message being built. other
must have the exact same type
as this
(i.e. getClass().equals(getDefaultInstanceForType().getClass())
).
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
Returns
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.
Parameter
Returns
Type | Description |
BuilderType | |
Exceptions
public BuilderType mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Type | Description |
BuilderType | |
Exceptions