com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType > Class Template Reference

Inheritance diagram for com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >:

Classes
class	LimitedInputStream

Public Member Functions
abstract BuilderType	clone ()
boolean	mergeDelimitedFrom (final InputStream input) throws IOException
boolean	mergeDelimitedFrom (final InputStream input, final ExtensionRegistryLite extensionRegistry) throws IOException
BuilderType	mergeFrom (final byte[] data) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final byte[] data, final ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final byte[] data, final int off, final int len) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final byte[] data, final int off, final int len, final ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final ByteString data) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final ByteString data, final ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final CodedInputStream input) throws IOException
abstract BuilderType	mergeFrom (final CodedInputStream input, final ExtensionRegistryLite extensionRegistry) throws IOException
BuilderType	mergeFrom (final InputStream input) throws IOException
BuilderType	mergeFrom (final InputStream input, final ExtensionRegistryLite extensionRegistry) throws IOException
BuilderType	mergeFrom (final MessageLite other)
Public Member Functions inherited from com.google.protobuf.MessageLite.Builder
MessageLite	build ()
MessageLite	buildPartial ()
Builder	clear ()
Public Member Functions inherited from com.google.protobuf.MessageLiteOrBuilder
MessageLite	getDefaultInstanceForType ()
boolean	isInitialized ()

Protected Member Functions
abstract BuilderType	internalMergeFrom (MessageType message)

Static Protected Member Functions
static< T > void	addAll (final Iterable< T > values, final Collection<? super T > list)
static< T > void	addAll (final Iterable< T > values, final List<? super T > list)
static UninitializedMessageException	newUninitializedMessageException (MessageLite message)

Private Member Functions
String	getReadingExceptionMessage (String target)

Static Private Member Functions
static< T > void	addAllCheckingNulls (Iterable< T > values, List<? super T > list)

Detailed Description

A partial implementation of the Message.Builder interface which implements as many methods of that interface as possible in terms of other methods.

Definition at line 154 of file AbstractMessageLite.java.

Member Function Documentation

addAll() [1/2]

static <T> void com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.addAll ( final Iterable< T >  values, final Collection<? super T >  list  )

inlinestaticprotected

Definition at line 384 of file AbstractMessageLite.java.

addAll() [2/2]

static <T> void com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.addAll ( final Iterable< T >  values, final List<? super T >  list  )

inlinestaticprotected

Adds the

values 

to the

list 

. This is a helper method used by generated code. Users should ignore it.

Exceptions

NullPointerException

if values or any of the elements of values is null.

Definition at line 395 of file AbstractMessageLite.java.

addAllCheckingNulls()

static <T> void com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.addAllCheckingNulls ( Iterable< T >  values, List<? super T >  list  )

inlinestaticprivate

Definition at line 358 of file AbstractMessageLite.java.

clone()

abstract BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.clone ( )

abstract

Clones the Builder.

See also

Object::clone()

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

getReadingExceptionMessage()

String com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.getReadingExceptionMessage ( String  target )

inlineprivate

Definition at line 349 of file AbstractMessageLite.java.

internalMergeFrom()

abstract BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.internalMergeFrom ( MessageType  message )

abstractprotected

mergeDelimitedFrom() [1/2]

boolean com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeDelimitedFrom ( final InputStream  input ) throws IOException

inline

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 {} 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.

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 332 of file AbstractMessageLite.java.

mergeDelimitedFrom() [2/2]

boolean com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeDelimitedFrom ( final InputStream  input, final ExtensionRegistryLite  extensionRegistry  ) throws IOException

inline

Like mergeDelimitedFrom(InputStream) but supporting extensions.

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 319 of file AbstractMessageLite.java.

mergeFrom() [1/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final byte[]  data ) throws InvalidProtocolBufferException

inline

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).

Returns

this

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 204 of file AbstractMessageLite.java.

mergeFrom() [2/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final byte[]  data, final ExtensionRegistryLite  extensionRegistry  ) throws InvalidProtocolBufferException

inline

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).

Returns

this

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 224 of file AbstractMessageLite.java.

mergeFrom() [3/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final byte[]  data, final int  off, final int  len  ) throws InvalidProtocolBufferException

inline

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).

Returns

this

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 209 of file AbstractMessageLite.java.

mergeFrom() [4/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final byte[]  data, final int  off, final int  len, final ExtensionRegistryLite  extensionRegistry  ) throws InvalidProtocolBufferException

inline

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).

Returns

this

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 230 of file AbstractMessageLite.java.

mergeFrom() [5/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final ByteString  data ) throws InvalidProtocolBufferException

inline

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).

Returns

this

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 174 of file AbstractMessageLite.java.

mergeFrom() [6/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final ByteString  data, final ExtensionRegistryLite  extensionRegistry  ) throws InvalidProtocolBufferException

inline

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).

Returns

this

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 188 of file AbstractMessageLite.java.

mergeFrom() [7/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final CodedInputStream  input ) throws IOException

inline

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 {}, 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.

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 163 of file AbstractMessageLite.java.

mergeFrom() [8/11]

abstract BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final CodedInputStream  input, final ExtensionRegistryLite  extensionRegistry  ) throws IOException

abstract

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.

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

mergeFrom() [9/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final InputStream  input ) throws IOException

inline

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 {} to read it. Despite usually reading the entire input, this does not close the stream.

Returns

this

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 249 of file AbstractMessageLite.java.

mergeFrom() [10/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final InputStream  input, final ExtensionRegistryLite  extensionRegistry  ) throws IOException

inline

Parse a message of this type from

input 

and merge it with the message being built. This is just a small wrapper around {}. this

Implements com.google.protobuf.MessageLite.Builder.

Reimplemented in com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.

Definition at line 257 of file AbstractMessageLite.java.

mergeFrom() [11/11]

BuilderType com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.mergeFrom ( final MessageLite  other )

inline

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++.

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 338 of file AbstractMessageLite.java.

newUninitializedMessageException()

static UninitializedMessageException com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.newUninitializedMessageException ( MessageLite  message )

inlinestaticprotected

Construct an UninitializedMessageException reporting missing fields in the given message.

Definition at line 377 of file AbstractMessageLite.java.

---

The documentation for this class was generated from the following file:

• AbstractMessageLite.java