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

[legend]

Public Member Functions
Builder	addRepeatedField (Descriptors.FieldDescriptor field, Object value)

Message	build ()

Message	buildPartial ()

Builder	clear ()

Builder	clearField (Descriptors.FieldDescriptor field)

Builder	clearOneof (Descriptors.OneofDescriptor oneof)

Builder	clone ()

Descriptors.Descriptor	getDescriptorForType ()

Builder	getFieldBuilder (Descriptors.FieldDescriptor field)

Builder	getRepeatedFieldBuilder (Descriptors.FieldDescriptor field, int index)

boolean	mergeDelimitedFrom (InputStream input) throws IOException

boolean	mergeDelimitedFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException

Builder	mergeFrom (byte[] data) throws InvalidProtocolBufferException

Builder	mergeFrom (byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException

Builder	mergeFrom (byte[] data, int off, int len) throws InvalidProtocolBufferException

Builder	mergeFrom (byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException

Builder	mergeFrom (ByteString data) throws InvalidProtocolBufferException

Builder	mergeFrom (ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException

Builder	mergeFrom (CodedInputStream input) throws IOException

Builder	mergeFrom (CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException

Builder	mergeFrom (InputStream input) throws IOException

Builder	mergeFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException

Builder	mergeFrom (Message other)

Builder	mergeUnknownFields (UnknownFieldSet unknownFields)

Builder	newBuilderForField (Descriptors.FieldDescriptor field)

Builder	setField (Descriptors.FieldDescriptor field, Object value)

Builder	setRepeatedField (Descriptors.FieldDescriptor field, int index, Object value)

Builder	setUnknownFields (UnknownFieldSet unknownFields)

Public Member Functions inherited from com.google.protobuf.MessageLite.Builder
Builder	mergeFrom (MessageLite other)

Public Member Functions inherited from com.google.protobuf.MessageLiteOrBuilder
boolean	isInitialized ()

Public Member Functions inherited from com.google.protobuf.MessageOrBuilder
List< String >	findInitializationErrors ()

Map< Descriptors.FieldDescriptor, Object >	getAllFields ()

Message	getDefaultInstanceForType ()

Object	getField (Descriptors.FieldDescriptor field)

String	getInitializationErrorString ()

Descriptors.FieldDescriptor	getOneofFieldDescriptor (Descriptors.OneofDescriptor oneof)

Object	getRepeatedField (Descriptors.FieldDescriptor field, int index)

int	getRepeatedFieldCount (Descriptors.FieldDescriptor field)

UnknownFieldSet	getUnknownFields ()

boolean	hasField (Descriptors.FieldDescriptor field)

boolean	hasOneof (Descriptors.OneofDescriptor oneof)

Detailed Description

Abstract interface implemented by Protocol Message builders.

Definition at line 104 of file Message.java.

Member Function Documentation

◆ addRepeatedField()

Builder com.google.protobuf.Message.Builder.addRepeatedField	(	Descriptors.FieldDescriptor	field,
		Object	value
	)

Like

setRepeatedField

, but appends the value as a new element.

Exceptions

IllegalArgumentException

The field is not a repeated field, or

field.getContainingType() != getDescriptorForType()

.

◆ build()

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

Implements com.google.protobuf.MessageLite.Builder.

◆ buildPartial()

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

Implements com.google.protobuf.MessageLite.Builder.

◆ clear()

Builder com.google.protobuf.Message.Builder.clear ( )

Resets all fields to their default values.

Implements com.google.protobuf.MessageLite.Builder.

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

◆ clearField()

Builder com.google.protobuf.Message.Builder.clearField ( Descriptors.FieldDescriptor field )

Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.

◆ clearOneof()

Builder com.google.protobuf.Message.Builder.clearOneof ( Descriptors.OneofDescriptor oneof )

Clears the oneof. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the oneof.

◆ clone()

Builder com.google.protobuf.Message.Builder.clone ( )

Clones the Builder.

See also: Object::clone()

Implements com.google.protobuf.MessageLite.Builder.

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

◆ getDescriptorForType()

Descriptors.Descriptor com.google.protobuf.Message.Builder.getDescriptorForType ( )

Get the message's type's descriptor. See Message#getDescriptorForType().

Implements com.google.protobuf.MessageOrBuilder.

◆ getFieldBuilder()

Builder com.google.protobuf.Message.Builder.getFieldBuilder ( Descriptors.FieldDescriptor field )

Get a nested builder instance for the given field.

Normally, we hold a reference to the immutable message object for the message type field. Some implementations(the generated message builders), however, can also hold a reference to the builder object (a nested builder) for the field.

If the field is already backed up by a nested builder, the nested builder will be returned. Otherwise, a new field builder will be created and returned. The original message field (if exist) will be merged into the field builder, which will then be nested into its parent builder.

NOTE: implementations that do not support nested builders will throw UnsupportedOperationException.

◆ getRepeatedFieldBuilder()

Builder com.google.protobuf.Message.Builder.getRepeatedFieldBuilder	(	Descriptors.FieldDescriptor	field,
		int	index
	)

Get a nested builder instance for the given repeated field instance.

Normally, we hold a reference to the immutable message object for the message type field. Some implementations(the generated message builders), however, can also hold a reference to the builder object (a nested builder) for the field.

If the field is already backed up by a nested builder, the nested builder will be returned. Otherwise, a new field builder will be created and returned. The original message field (if exist) will be merged into the field builder, which will then be nested into its parent builder.

NOTE: implementations that do not support nested builders will throw UnsupportedOperationException.

◆ mergeDelimitedFrom() [1/2]

boolean com.google.protobuf.Message.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 {} 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.

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

◆ mergeDelimitedFrom() [2/2]

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

Like mergeDelimitedFrom(InputStream) but supporting extensions.

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [1/11]

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

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [2/11]

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

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [3/11]

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

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [4/11]

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

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [5/11]

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

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [6/11]

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

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [7/11]

Builder com.google.protobuf.Message.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 {}, 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.

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

◆ mergeFrom() [8/11]

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

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [9/11]

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

Returns: this

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [10/11]

Builder com.google.protobuf.Message.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 {}. this

Implements com.google.protobuf.MessageLite.Builder.

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

◆ mergeFrom() [11/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( Message other )

Merge

other

into the message being built.

other

must have the exact same type as

this

(i.e.

getDescriptorForType() == other.getDescriptorForType()

).

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

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

◆ mergeUnknownFields()

Builder com.google.protobuf.Message.Builder.mergeUnknownFields ( UnknownFieldSet unknownFields )

Merge some unknown fields into the UnknownFieldSet for this message.

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

◆ newBuilderForField()

Builder com.google.protobuf.Message.Builder.newBuilderForField ( Descriptors.FieldDescriptor field )

Create a builder for messages of the appropriate type for the given field. The builder is NOT nested in the current builder. However, messages built with the builder can then be passed to the setField(Descriptors.FieldDescriptor, Object), setRepeatedField(Descriptors.FieldDescriptor, int, Object), or addRepeatedField(Descriptors.FieldDescriptor, Object) method of the current builder.

To obtain a builder nested in the current builder, use getFieldBuilder(Descriptors.FieldDescriptor) instead.

◆ setField()

Builder com.google.protobuf.Message.Builder.setField	(	Descriptors.FieldDescriptor	field,
		Object	value
	)

Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that Message#getField(Descriptors.FieldDescriptor) would return.

◆ setRepeatedField()

Builder com.google.protobuf.Message.Builder.setRepeatedField	(	Descriptors.FieldDescriptor	field,
		int	index,
		Object	value
	)

Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that {} would return. IllegalArgumentException The field is not a repeated field, or field.getContainingType() != getDescriptorForType() .

◆ setUnknownFields()

Builder com.google.protobuf.Message.Builder.setUnknownFields ( UnknownFieldSet unknownFields )

Set the UnknownFieldSet for this message.

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

Message.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ addRepeatedField()

◆ build()

◆ buildPartial()

◆ clear()

◆ clearField()

◆ clearOneof()

◆ clone()

◆ getDescriptorForType()

◆ getFieldBuilder()

◆ getRepeatedFieldBuilder()

◆ mergeDelimitedFrom() [1/2]

◆ mergeDelimitedFrom() [2/2]

◆ mergeFrom() [1/11]

◆ mergeFrom() [2/11]

◆ mergeFrom() [3/11]

◆ mergeFrom() [4/11]

◆ mergeFrom() [5/11]

◆ mergeFrom() [6/11]

◆ mergeFrom() [7/11]

◆ mergeFrom() [8/11]

◆ mergeFrom() [9/11]

◆ mergeFrom() [10/11]

◆ mergeFrom() [11/11]

◆ mergeUnknownFields()

◆ newBuilderForField()

◆ setField()

◆ setRepeatedField()

◆ setUnknownFields()