Interface Message.Builder (3.19.4)

Abstract interface implemented by Protocol Message builders.

Like setRepeatedField , but appends the value as a new element.

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

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.

Resets all fields to their default values.

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

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

Clones the Builder.

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

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 .

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 .

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.

Like #mergeDelimitedFrom(InputStream) but supporting extensions.

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

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

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

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

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

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

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.

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.

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

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.

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

Merge some unknown fields into the UnknownFieldSet for this message.

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.

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.

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 Message#getRepeatedField(Descriptors.FieldDescriptor,int) would return.

Set the UnknownFieldSet for this message.