com.google.protobuf.MessageLite.Builder Interface Reference

Inheritance diagram for com.google.protobuf.MessageLite.Builder:

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

Detailed Description

Abstract interface implemented by Protocol Message builders.

Member Function Documentation

build()

MessageLite com.google.protobuf.MessageLite.Builder.build

(

)

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Exceptions

UninitializedMessageException

The message is missing one or more required fields (i.e. isInitialized() returns false). Use buildPartial() to bypass this check.

Implemented in com.google.protobuf.Message.Builder.

buildPartial()

MessageLite com.google.protobuf.MessageLite.Builder.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.

Implemented in com.google.protobuf.Message.Builder.

clear()

Builder com.google.protobuf.MessageLite.Builder.clear

(

)

Resets all fields to their default values.

Implemented in com.google.protobuf.Message.Builder.

clone()

Builder com.google.protobuf.MessageLite.Builder.clone

(

)

Clones the Builder.

See also

Object::clone()

Implemented in com.google.protobuf.Message.Builder.

mergeDelimitedFrom() [1/2]

boolean com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom

(

InputStream

input

)

throws IOException

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.

Returns

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.

Implemented in com.google.protobuf.Message.Builder.

mergeDelimitedFrom() [2/2]

boolean com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom	(	InputStream	input,
		ExtensionRegistryLite	extensionRegistry
	)		throws IOException

Like mergeDelimitedFrom(InputStream) but supporting extensions.

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [1/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom

(

CodedInputStream

input

)

throws IOException

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.

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [2/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom	(	CodedInputStream	input,
		ExtensionRegistryLite	extensionRegistry
	)		throws IOException

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.

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [3/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom

(

ByteString

data

)

throws InvalidProtocolBufferException

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

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [4/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom	(	ByteString	data,
		ExtensionRegistryLite	extensionRegistry
	)		throws InvalidProtocolBufferException

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

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [5/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom

(

byte []

data

)

throws InvalidProtocolBufferException

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

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [6/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom	(	byte []	data,
		int	off,
		int	len
	)		throws InvalidProtocolBufferException

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

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [7/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom	(	byte []	data,
		ExtensionRegistryLite	extensionRegistry
	)		throws InvalidProtocolBufferException

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

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [8/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom	(	byte []	data,
		int	off,
		int	len,
		ExtensionRegistryLite	extensionRegistry
	)		throws InvalidProtocolBufferException

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

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [9/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom

(

InputStream

input

)

throws IOException

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.

Returns

this

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [10/11]

Builder com.google.protobuf.MessageLite.Builder.mergeFrom	(	InputStream	input,
		ExtensionRegistryLite	extensionRegistry
	)		throws IOException

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

Returns

this

Implemented in com.google.protobuf.Message.Builder.

mergeFrom() [11/11]

Builder com.google.protobuf.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 

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

---

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

• Source/ThirdParty/libwebrtc/Source/third_party/protobuf/java/core/src/main/java/com/google/protobuf/MessageLite.java