public
static
interface
MessageLite
.
Builder
extends
MessageLiteOrBuilder
,
Cloneable
Abstract interface implemented by Protocol Message builders.
Methods
build()
public
abstract
MessageLite
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
MessageLite
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
MessageLite
.
Builder
clear
()
Resets all fields to their default values.
clone()
public
abstract
MessageLite
.
Builder
clone
()
Clones the Builder. See Also: Object#clone()
mergeDelimitedFrom(InputStream input)
public
abstract
boolean
mergeDelimitedFrom
(
InputStream
input
)
Like #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.
True if successful, or false if the stream is at EOF when the method starts. Any other error (including reaching EOF during parsing) will cause an exception to be thrown.
mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
abstract
boolean
mergeDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Like #mergeDelimitedFrom(InputStream) but supporting extensions.
mergeFrom(byte[] data)
public
abstract
MessageLite
.
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)
.
mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
abstract
MessageLite
.
Builder
mergeFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
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,ExtensionRegistryLite)
.
mergeFrom(byte[] data, int off, int len)
public
abstract
MessageLite
.
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
MessageLite
.
Builder
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. This
is just a small wrapper around #mergeFrom(CodedInputStream,ExtensionRegistryLite)
.
mergeFrom(ByteString data)
public
abstract
MessageLite
.
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
MessageLite
.
Builder
mergeFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
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,ExtensionRegistryLite)
.
mergeFrom(CodedInputStream input)
public
abstract
MessageLite
.
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.
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
abstract
MessageLite
.
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(MessageLite other)
public
abstract
MessageLite
.
Builder
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, thenother'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
otherare 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::MergeFrommethod in C++.
mergeFrom(InputStream input)
public
abstract
MessageLite
.
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.
mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
abstract
MessageLite
.
Builder
mergeFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
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,ExtensionRegistryLite)
.

