public static interface MessageLite.Builder extends MessageLiteOrBuilder, java.lang.Cloneable
Modifier and Type | Method and Description |
---|---|
MessageLite |
build()
Constructs the message based on the state of the Builder.
|
MessageLite |
buildPartial()
Like
build() , but does not throw an exception if the message is missing required
fields. |
MessageLite.Builder |
clear()
Resets all fields to their default values.
|
MessageLite.Builder |
clone()
Clones the Builder.
|
boolean |
mergeDelimitedFrom(java.io.InputStream input)
Like
mergeFrom(InputStream) , but does not read until EOF. |
boolean |
mergeDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Like
mergeDelimitedFrom(InputStream) but supporting extensions. |
MessageLite.Builder |
mergeFrom(byte[] data)
Parse
data as a message of this type and merge it with the message being built. |
MessageLite.Builder |
mergeFrom(byte[] data,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the message being built. |
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. |
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. |
MessageLite.Builder |
mergeFrom(ByteString data)
Parse
data as a message of this type and merge it with the message being built. |
MessageLite.Builder |
mergeFrom(ByteString data,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the message being built. |
MessageLite.Builder |
mergeFrom(CodedInputStream input)
Parses a message of this type from the input and merges it with this message.
|
MessageLite.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry)
Like
mergeFrom(CodedInputStream) , but also parses extensions. |
MessageLite.Builder |
mergeFrom(java.io.InputStream input)
Parse a message of this type from
input and merge it with the message being built. |
MessageLite.Builder |
mergeFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Parse a message of this type from
input and merge it with the message being built. |
MessageLite.Builder |
mergeFrom(MessageLite other)
Merge
other into the message being built. |
getDefaultInstanceForType, isInitialized
MessageLite.Builder clear()
MessageLite build()
UninitializedMessageException
- The message is missing one or more required fields
(i.e. MessageLiteOrBuilder.isInitialized()
returns false). Use buildPartial()
to bypass this
check.MessageLite buildPartial()
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.MessageLite.Builder clone()
Object.clone()
MessageLite.Builder mergeFrom(CodedInputStream input) throws java.io.IOException
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:
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.
java.io.IOException
MessageLite.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
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.java.io.IOException
MessageLite.Builder mergeFrom(ByteString data) throws InvalidProtocolBufferException
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around mergeFrom(CodedInputStream)
.InvalidProtocolBufferException
MessageLite.Builder mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
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)
.InvalidProtocolBufferException
MessageLite.Builder mergeFrom(byte[] data) throws InvalidProtocolBufferException
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around mergeFrom(CodedInputStream)
.InvalidProtocolBufferException
MessageLite.Builder mergeFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around mergeFrom(CodedInputStream)
.InvalidProtocolBufferException
MessageLite.Builder mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
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)
.InvalidProtocolBufferException
MessageLite.Builder mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
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)
.InvalidProtocolBufferException
MessageLite.Builder mergeFrom(java.io.InputStream input) throws java.io.IOException
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.
java.io.IOException
MessageLite.Builder mergeFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
input
and merge it with the message being built.
This is just a small wrapper around mergeFrom(CodedInputStream,ExtensionRegistryLite)
.java.io.IOException
MessageLite.Builder mergeFrom(MessageLite other)
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++.
boolean mergeDelimitedFrom(java.io.InputStream input) throws java.io.IOException
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.java.io.IOException
boolean mergeDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeDelimitedFrom(InputStream)
but supporting extensions.java.io.IOException
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.