MessageType
- the type of the message.BuilderType
- the type of the builder.public abstract static class AbstractMessageLite.Builder<MessageType extends AbstractMessageLite<MessageType,BuilderType>,BuilderType extends AbstractMessageLite.Builder<MessageType,BuilderType>> extends Object implements MessageLite.Builder
MessageLite.Builder
interface which implements as many methods of that
interface as possible in terms of other methods.Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
protected static <T> void |
addAll(Iterable<T> values,
Collection<? super T> list)
Adds the
values to the list . |
abstract BuilderType |
clone()
Creates and returns a copy of this object.
|
protected abstract BuilderType |
internalMergeFrom(MessageType message) |
boolean |
mergeDelimitedFrom(InputStream input)
Like
MessageLite.Builder.mergeFrom(InputStream) , but does not read until EOF. |
boolean |
mergeDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry)
Like
MessageLite.Builder.mergeDelimitedFrom(InputStream) but supporting extensions. |
BuilderType |
mergeFrom(byte[] data)
Parse
data as a message of this type and merge it with the message being built. |
BuilderType |
mergeFrom(byte[] data,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the message being built. |
BuilderType |
mergeFrom(byte[] data,
int off,
int len)
Parse
data as a message of this type and merge it with the message being built. |
BuilderType |
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. |
BuilderType |
mergeFrom(ByteString data)
Parse
data as a message of this type and merge it with the message being built. |
BuilderType |
mergeFrom(ByteString data,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the message being built. |
BuilderType |
mergeFrom(CodedInputStream input)
Parses a message of this type from the input and merges it with this message.
|
abstract BuilderType |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry)
Like
MessageLite.Builder.mergeFrom(CodedInputStream) , but also parses extensions. |
BuilderType |
mergeFrom(InputStream input)
Parse a message of this type from
input and merge it with the message being built. |
BuilderType |
mergeFrom(InputStream input,
ExtensionRegistryLite extensionRegistry)
Parse a message of this type from
input and merge it with the message being built. |
BuilderType |
mergeFrom(MessageLite other)
Merge
other into the message being built. |
protected static UninitializedMessageException |
newUninitializedMessageException(MessageLite message)
Construct an UninitializedMessageException reporting missing fields in the given message.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
build, buildPartial, clear
getDefaultInstanceForType, isInitialized
protected static <T> void addAll(Iterable<T> values, Collection<? super T> list)
values
to the list
. This is a helper method used by generated code. Users should
ignore it.values
- the values to add.list
- the list in which the values will be added.NullPointerException
- if values
or any of the elements of values
is null. When that happens, some
elements of values
may have already been added to the result list
.public abstract BuilderType clone()
Object
x
, the expression: will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true
, but these are not absolute requirements. While it is
typically the case that: will bex.clone().equals(x)
true
, this is not an absolute requirement.
By convention, the returned object should be obtained by calling super.clone
. If a class
and all of its superclasses (except Object
) obey this convention, it will be the case
that x.clone().getClass() == x.getClass()
.
By convention, the object returned by this method should be independent of this object (which is
being cloned). To achieve this independence, it may be necessary to modify one or more fields of
the object returned by super.clone
before returning it. Typically, this means copying any
mutable objects that comprise the internal "deep structure" of the object being cloned and
replacing the references to these objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually the case that no fields
in the object returned by super.clone
need to be modified.
The method clone
for class Object
performs a specific cloning operation. First,
if the class of this object does not implement the interface Cloneable
, then a
CloneNotSupportedException
is thrown. Note that all arrays are considered to implement
the interface Cloneable
and that the return type of the clone
method of an array
type T[]
is T[]
where T is any reference or primitive type. Otherwise, this
method creates a new instance of the class of this object and initializes all its fields with
exactly the contents of the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of
this object, not a "deep copy" operation.
The class Object
does not itself implement the interface Cloneable
, so calling
the clone
method on an object whose class is Object
will result in throwing an
exception at run time.
clone
in interface MessageLite.Builder
clone
in class Object
Cloneable
protected abstract BuilderType internalMergeFrom(MessageType message)
public boolean mergeDelimitedFrom(InputStream input) throws IOException
MessageLite.Builder
MessageLite.Builder.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.mergeDelimitedFrom
in interface MessageLite.Builder
IOException
public boolean mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
MessageLite.Builder
MessageLite.Builder.mergeDelimitedFrom(InputStream)
but supporting extensions.mergeDelimitedFrom
in interface MessageLite.Builder
IOException
public BuilderType mergeFrom(byte[] data) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This is just a small
wrapper around MessageLite.Builder.mergeFrom(CodedInputStream)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
public BuilderType mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This is just a small
wrapper around MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
public BuilderType mergeFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This is just a small
wrapper around MessageLite.Builder.mergeFrom(CodedInputStream)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
public BuilderType mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This is just a small
wrapper around MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
public BuilderType mergeFrom(ByteString data) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This is just a small
wrapper around MessageLite.Builder.mergeFrom(CodedInputStream)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
public BuilderType mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This is just a small
wrapper around MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
public BuilderType mergeFrom(CodedInputStream input) throws IOException
MessageLite.Builder
Warning: This does not verify that all required fields are present in the input message. If you call
MessageLite.Builder.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.
mergeFrom
in interface MessageLite.Builder
IOException
public abstract BuilderType mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
MessageLite.Builder
MessageLite.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
in interface MessageLite.Builder
IOException
public BuilderType mergeFrom(InputStream input) throws IOException
MessageLite.Builder
input
and merge it with the message being built. This is just a
small wrapper around MessageLite.Builder.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
MessageLite.Builder.mergeDelimitedFrom(InputStream)
to read it.
Despite usually reading the entire input, this does not close the stream.
mergeFrom
in interface MessageLite.Builder
IOException
public BuilderType mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
MessageLite.Builder
input
and merge it with the message being built. This is just a
small wrapper around MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)
.mergeFrom
in interface MessageLite.Builder
IOException
public BuilderType mergeFrom(MessageLite other)
MessageLite.Builder
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:other
, then other
's value overwrites
the value in this message.other
, it is merged into the corresponding
sub-message of this message using the same merging rules.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++.mergeFrom
in interface MessageLite.Builder
protected static UninitializedMessageException newUninitializedMessageException(MessageLite message)
message
- the message from which the exception will be constructed.