Class AbstractMessageLite.Builder<MessageType extends AbstractMessageLite<MessageType,BuilderType>,BuilderType extends AbstractMessageLite.Builder<MessageType,BuilderType>>
- All Implemented Interfaces:
MessageLite.Builder,MessageLiteOrBuilder,Cloneable
- Direct Known Subclasses:
AbstractMessage.Builder,GeneratedMessageLite.Builder
- Enclosing class:
- AbstractMessageLite<MessageType extends AbstractMessageLite<MessageType,
BuilderType>, BuilderType extends AbstractMessageLite.Builder<MessageType, BuilderType>>
Message.Builder interface which implements as many
methods of that interface as possible in terms of other methods.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static final classAn InputStream implementations which reads from some other InputStream but is limited to a particular number of bytes. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected static <T> voidaddAll(Iterable<T> values, Collection<? super T> list) Deprecated.protected static <T> voidAdds thevaluesto thelist.private static <T> voidaddAllCheckingNulls(Iterable<T> values, List<? super T> list) abstract BuilderTypeclone()Clones the Builder.private StringgetReadingExceptionMessage(String target) protected abstract BuilderTypeinternalMergeFrom(MessageType message) booleanmergeDelimitedFrom(InputStream input) LikeMessageLite.Builder.mergeFrom(InputStream), but does not read until EOF.booleanmergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) LikeMessageLite.Builder.mergeDelimitedFrom(InputStream)but supporting extensions.mergeFrom(byte[] data) Parsedataas a message of this type and merge it with the message being built.mergeFrom(byte[] data, int off, int len) Parsedataas a message of this type and merge it with the message being built.mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) Parsedataas a message of this type and merge it with the message being built.mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) Parsedataas a message of this type and merge it with the message being built.mergeFrom(ByteString data) Parsedataas a message of this type and merge it with the message being built.mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) Parsedataas a message of this type and merge it with the message being built.mergeFrom(CodedInputStream input) Parses a message of this type from the input and merges it with this message.abstract BuilderTypemergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) LikeMessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.mergeFrom(MessageLite other) Mergeotherinto the message being built.mergeFrom(InputStream input) Parse a message of this type frominputand merge it with the message being built.mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Parse a message of this type frominputand merge it with the message being built.protected static UninitializedMessageExceptionConstruct an UninitializedMessageException reporting missing fields in the given message.Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite.Builder
build, buildPartial, clearMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
clone
Description copied from interface:MessageLite.BuilderClones the Builder.- Specified by:
clonein interfaceMessageLite.Builder- Overrides:
clonein classObject- See Also:
-
mergeFrom
Description copied from interface:MessageLite.BuilderParses 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
MessageLite.Builder.build()without setting all required fields, it will throw anUninitializedMessageException, which is aRuntimeExceptionand thus might not be caught. There are a few good ways to deal with this:- Call
MessageLiteOrBuilder.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.- Specified by:
mergeFromin interfaceMessageLite.Builder- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
- Call
-
mergeFrom
public abstract BuilderType mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.BuilderLikeMessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered inextensionRegistry. Extensions not in the registry will be treated as unknown fields.- Specified by:
mergeFromin interfaceMessageLite.Builder- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
-
mergeFrom
Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream).- Specified by:
mergeFromin interfaceMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
public BuilderType mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).- Specified by:
mergeFromin interfaceMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream).- Specified by:
mergeFromin interfaceMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream).- Specified by:
mergeFromin interfaceMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
public BuilderType mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).- Specified by:
mergeFromin interfaceMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
public BuilderType mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).- Specified by:
mergeFromin interfaceMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
Description copied from interface:MessageLite.BuilderParse a message of this type frominputand merge it with the message being built. This is just a small wrapper aroundMessageLite.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, useMessageLite.writeDelimitedTo(OutputStream)to write your message andMessageLite.Builder.mergeDelimitedFrom(InputStream)to read it.Despite usually reading the entire input, this does not close the stream.
- Specified by:
mergeFromin interfaceMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
-
mergeFrom
public BuilderType mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.BuilderParse a message of this type frominputand merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).- Specified by:
mergeFromin interfaceMessageLite.Builder- Returns:
- this
- Throws:
IOException
-
mergeDelimitedFrom
public boolean mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.BuilderLikeMessageLite.Builder.mergeDelimitedFrom(InputStream)but supporting extensions.- Specified by:
mergeDelimitedFromin interfaceMessageLite.Builder- Returns:
- true if successful, or false if the stream is at EOF when the method starts. Any other error (including reaching EOF during parsing) causes an exception to be thrown.
- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
-
mergeDelimitedFrom
Description copied from interface:MessageLite.BuilderLikeMessageLite.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. UseMessageLite.writeDelimitedTo(OutputStream)to write messages in this format.- Specified by:
mergeDelimitedFromin interfaceMessageLite.Builder- Returns:
- true if successful, or false if the stream is at EOF when the method starts. Any other error (including reaching EOF during parsing) causes an exception to be thrown.
- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
-
mergeFrom
Description copied from interface:MessageLite.BuilderMergeotherinto the message being built.othermust have the exact same type asthis(i.e.getClass().equals(getDefaultInstanceForType().getClass())).Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set inother, thenother's value overwrites the value in this message.
* For singular message fields, if the field is set inother, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements inotherare 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++.- Specified by:
mergeFromin interfaceMessageLite.Builder
-
internalMergeFrom
-
getReadingExceptionMessage
-
addAllCheckingNulls
-
newUninitializedMessageException
protected static UninitializedMessageException newUninitializedMessageException(MessageLite message) Construct an UninitializedMessageException reporting missing fields in the given message. -
addAll
Deprecated. -
addAll
Adds thevaluesto thelist. This is a helper method used by generated code. Users should ignore it.- Throws:
NullPointerException- ifvaluesor any of the elements ofvaluesis null.
-