Modifier and Type	Class and Description
public static interface	Message.Builder Abstract interface implemented by Protocol Message builders.

Modifier and Type	Method and Description
public boolean	Returns: `true` if the specified object is equal to this message equals(Object object to be compared for equality with this message other) Compares the specified object with this message for equality.
public Parser<? extends Message>	getParserForType() Redeclares com.google.protobuf.MessageLite.getParserForType. Gets the parser for a message of the same type as this message.
public int	Returns: the hash code value for this message hashCode() Returns the hash code value for this message.
public Message.Builder	newBuilderForType() Redeclares com.google.protobuf.MessageLite.newBuilderForType. Constructs a new builder for a message of the same type as this message.
public Message.Builder	toBuilder() Redeclares com.google.protobuf.MessageLite.toBuilder. Constructs a builder initialized with the current message.
public String	toString() Converts the message to a string in protocol buffer text format.

equals	back to summary
public boolean equals(Object other) Compares the specified object with this message for equality. Returns `true` if the given object is a message of the same type (as defined by `getDescriptorForType()`) and has identical values for all of its fields. Subclasses must implement this; inheriting `Object.equals()` is incorrect. Parameters other:Object object to be compared for equality with this message Returns:boolean `true` if the specified object is equal to this message Annotations @Override

getParserForType	back to summary
public Parser<? extends Message> getParserForType() Redeclares com.google.protobuf.MessageLite.getParserForType. Doc from com.google.protobuf.MessageLite.getParserForType. Gets the parser for a message of the same type as this message. Annotations @Override

hashCode	back to summary
public int hashCode() Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting `Object.hashCode()` is incorrect. Returns:int the hash code value for this message Annotations @Override See Also `Map#hashCode()`

newBuilderForType	back to summary
public Message.Builder newBuilderForType() Redeclares com.google.protobuf.MessageLite.newBuilderForType. Doc from com.google.protobuf.MessageLite.newBuilderForType. Constructs a new builder for a message of the same type as this message. Annotations @Override

toBuilder	back to summary
public Message.Builder toBuilder() Redeclares com.google.protobuf.MessageLite.toBuilder. Doc from com.google.protobuf.MessageLite.toBuilder. Constructs a builder initialized with the current message. Use this to derive a new message from the current one. Annotations @Override

toString	back to summary
public String toString() Converts the message to a string in protocol buffer text format. This is just a trivial wrapper around `TextFormat#printToString(MessageOrBuilder)`. Annotations @Override

public Interface Message.Builder

Known Direct Implementers: com.google.protobuf.AbstractMessage.Builder

Abstract interface implemented by Protocol Message builders.

Method Summary

Modifier and Type	Method and Description
public Message.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value) Like `setRepeatedField`, but appends the value as a new element.
public Message	build() Redeclares com.google.protobuf.MessageLite.Builder.build. Constructs the message based on the state of the Builder.
public Message	buildPartial() Redeclares com.google.protobuf.MessageLite.Builder.buildPartial. Like `build()`, but does not throw an exception if the message is missing required fields.
public Message.Builder	clear() Redeclares com.google.protobuf.MessageLite.Builder.clear. Resets all fields to their default values.
public Message.Builder	clearField(Descriptors.FieldDescriptor field) Clears the field.
public Message.Builder	clearOneof(Descriptors.OneofDescriptor oneof) Clears the oneof.
public Message.Builder	clone() Redeclares com.google.protobuf.MessageLite.Builder.clone. Clones the Builder.
public Descriptors.Descriptor	getDescriptorForType() Redeclares com.google.protobuf.MessageOrBuilder.getDescriptorForType. Get the message's type's descriptor.
public Message.Builder	getFieldBuilder(Descriptors.FieldDescriptor field) Get a nested builder instance for the given field.
public Message.Builder	getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index) Get a nested builder instance for the given repeated field instance.
public boolean	mergeDelimitedFrom(InputStream input) Redeclares com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom. Like `mergeFrom(InputStream)`, but does not read until EOF.
public boolean	mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Redeclares com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom. Like `mergeDelimitedFrom(InputStream)` but supporting extensions.
public Message.Builder	mergeFrom(Message other) Merge `other` into the message being built.
public Message.Builder	mergeFrom(CodedInputStream input) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parses a message of this type from the input and merges it with this message.
public Message.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Like `Builder#mergeFrom(CodedInputStream)`, but also parses extensions.
public Message.Builder	mergeFrom(ByteString data) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parse `data` as a message of this type and merge it with the message being built.
public Message.Builder	mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parse `data` as a message of this type and merge it with the message being built.
public Message.Builder	mergeFrom(byte[] data) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parse `data` as a message of this type and merge it with the message being built.
public Message.Builder	mergeFrom(byte[] data, int off, int len) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parse `data` as a message of this type and merge it with the message being built.
public Message.Builder	mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parse `data` as a message of this type and merge it with the message being built.
public Message.Builder	mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parse `data` as a message of this type and merge it with the message being built.
public Message.Builder	mergeFrom(InputStream input) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parse a message of this type from `input` and merge it with the message being built.
public Message.Builder	mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Parse a message of this type from `input` and merge it with the message being built.
public Message.Builder	mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into the `UnknownFieldSet` for this message.
public Message.Builder	newBuilderForField(Descriptors.FieldDescriptor field) Create a builder for messages of the appropriate type for the given field.
public Message.Builder	setField(Descriptors.FieldDescriptor field, Object value) Sets a field to the given value.
public Message.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) Sets an element of a repeated field to the given value.
public Message.Builder	setUnknownFields(UnknownFieldSet unknownFields) Set the `UnknownFieldSet` for this message.

Inherited from com.google.protobuf.MessageLite.Builder:: mergeFrom
Inherited from com.google.protobuf.MessageOrBuilder:: findInitializationErrors getAllFields getDefaultInstanceForType getField getInitializationErrorString getOneofFieldDescriptor getRepeatedField getRepeatedFieldCount getUnknownFields hasField hasOneof

Method Detail

addRepeatedField back to summary

addRepeatedField	back to summary
public 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()`.

public 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	back to summary
public Message build() Redeclares com.google.protobuf.MessageLite.Builder.build. Doc from 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. Annotations @Override

build

back to summary

public Message build()

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

Doc from 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.

Annotations

@Override

buildPartial back to summary

buildPartial	back to summary
public Message buildPartial() Redeclares com.google.protobuf.MessageLite.Builder.buildPartial. Doc from 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. Annotations @Override

public Message buildPartial()

Redeclares com.google.protobuf.MessageLite.Builder.buildPartial.

Doc from 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.

Annotations

@Override

clear	back to summary
public Message.Builder clear() Redeclares com.google.protobuf.MessageLite.Builder.clear. Doc from com.google.protobuf.MessageLite.Builder.clear. Resets all fields to their default values. Annotations @Override

clear

back to summary

public Message.Builder clear()

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

Doc from com.google.protobuf.MessageLite.Builder.clear.

Resets all fields to their default values.

Annotations

@Override

clearField	back to summary
public 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	back to summary
public 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	back to summary
public Message.Builder clone() Redeclares com.google.protobuf.MessageLite.Builder.clone. Doc from com.google.protobuf.MessageLite.Builder.clone. Clones the Builder. Annotations @Override

clone

back to summary

public Message.Builder clone()

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

Doc from com.google.protobuf.MessageLite.Builder.clone.

Clones the Builder.

Annotations

@Override

getDescriptorForType back to summary

getDescriptorForType	back to summary
public Descriptors.Descriptor getDescriptorForType() Redeclares com.google.protobuf.MessageOrBuilder.getDescriptorForType. Get the message's type's descriptor. See `Message#getDescriptorForType()`. Annotations @Override

public Descriptors.Descriptor getDescriptorForType()

Redeclares com.google.protobuf.MessageOrBuilder.getDescriptorForType.

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

Annotations

@Override

getFieldBuilder back to summary

getFieldBuilder	back to summary
public 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`.

public 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 back to summary

getRepeatedFieldBuilder	back to summary
public 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`.

public Message.Builder getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)

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

Note

implementations that do not support nested builders will throw UnsupportedOperationException.

mergeDelimitedFrom back to summary

mergeDelimitedFrom	back to summary
public boolean mergeDelimitedFrom(InputStream input) throws IOException Redeclares com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom. 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:boolean 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. Annotations @Override

public boolean mergeDelimitedFrom(InputStream input) throws IOException

Redeclares com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom.

Doc from com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom.

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:boolean

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.

Annotations

@Override

mergeDelimitedFrom back to summary

mergeDelimitedFrom	back to summary
public boolean mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Redeclares com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom. Like `mergeDelimitedFrom(InputStream)` but supporting extensions. Annotations @Override

public boolean mergeDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException

Redeclares com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom.

Doc from com.google.protobuf.MessageLite.Builder.mergeDelimitedFrom.

Like mergeDelimitedFrom(InputStream) but supporting extensions.

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public 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++.

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

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(CodedInputStream input) throws IOException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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. Annotations @Override

public Message.Builder mergeFrom(CodedInputStream input) throws IOException

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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.

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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. Annotations @Override

public Message.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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.

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(ByteString data) throws InvalidProtocolBufferException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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:Message.Builder this Annotations @Override

public Message.Builder mergeFrom(ByteString data) throws InvalidProtocolBufferException

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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:Message.Builder

this

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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:Message.Builder this Annotations @Override

public Message.Builder mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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:Message.Builder

this

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(byte[] data) throws InvalidProtocolBufferException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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:Message.Builder this Annotations @Override

public Message.Builder mergeFrom(byte[] data) throws InvalidProtocolBufferException

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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:Message.Builder

this

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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:Message.Builder this Annotations @Override

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

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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:Message.Builder

this

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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:Message.Builder this Annotations @Override

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

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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:Message.Builder

this

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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:Message.Builder this Annotations @Override

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

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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:Message.Builder

this

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(InputStream input) throws IOException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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:Message.Builder this Annotations @Override

public Message.Builder mergeFrom(InputStream input) throws IOException

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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:Message.Builder

this

Annotations

@Override

mergeFrom back to summary

mergeFrom	back to summary
public Message.Builder mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Redeclares com.google.protobuf.MessageLite.Builder.mergeFrom. Doc from com.google.protobuf.MessageLite.Builder.mergeFrom. 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:Message.Builder this Annotations @Override

public Message.Builder mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException

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

Doc from com.google.protobuf.MessageLite.Builder.mergeFrom.

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:Message.Builder

this

Annotations

@Override

mergeUnknownFields	back to summary
public Message.Builder mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into the `UnknownFieldSet` for this message.

newBuilderForField back to summary

newBuilderForField	back to summary
public 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.

public 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	back to summary
public 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 back to summary

setRepeatedField	back to summary
public 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 `Message#getRepeatedField(Descriptors.FieldDescriptor, int)` would return. Exceptions IllegalArgumentException: The field is not a repeated field, or `field.getContainingType() != getDescriptorForType()`.

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

Exceptions

IllegalArgumentException:: The field is not a repeated field, or field.getContainingType() != getDescriptorForType().

setUnknownFields	back to summary
public Message.Builder setUnknownFields(UnknownFieldSet unknownFields) Set the `UnknownFieldSet` for this message.

public Interface Message

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface Message.Builder

Method Summary

Method Detail