com.google.protobuf
Interface Message.Builder

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

AbstractMessage.Builder, DescriptorProtos.DescriptorProto.Builder, DescriptorProtos.DescriptorProto.ExtensionRange.Builder, DescriptorProtos.EnumDescriptorProto.Builder, DescriptorProtos.EnumOptions.Builder, DescriptorProtos.EnumValueDescriptorProto.Builder, DescriptorProtos.EnumValueOptions.Builder, DescriptorProtos.FieldDescriptorProto.Builder, DescriptorProtos.FieldOptions.Builder, DescriptorProtos.FileDescriptorProto.Builder, DescriptorProtos.FileDescriptorSet.Builder, DescriptorProtos.FileOptions.Builder, DescriptorProtos.MessageOptions.Builder, DescriptorProtos.MethodDescriptorProto.Builder, DescriptorProtos.MethodOptions.Builder, DescriptorProtos.ServiceDescriptorProto.Builder, DescriptorProtos.ServiceOptions.Builder, DescriptorProtos.UninterpretedOption.Builder, DescriptorProtos.UninterpretedOption.NamePart.Builder, DynamicMessage.Builder, GeneratedMessage.Builder, GeneratedMessage.ExtendableBuilder

Enclosing interface:

Message

public static interface Message.Builder
extends java.lang.Cloneable

Abstract interface implemented by Protocol Message builders.

Method Summary

Message.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value) Like setRepeatedField, but appends the value as a new element.
Message	build() Construct the final message.
Message	buildPartial() Like build(), but does not throw an exception if the message is missing required fields.
Message.Builder	clear() Resets all fields to their default values.
Message.Builder	clearField(Descriptors.FieldDescriptor field) Clears the field.
Message.Builder	clone() Clones the Builder.
java.util.Map<Descriptors.FieldDescriptor,java.lang.Object>	getAllFields() Like Message.getAllFields().
Message	getDefaultInstanceForType() Get the message's type's default instance.
Descriptors.Descriptor	getDescriptorForType() Get the message's type's descriptor.
java.lang.Object	getField(Descriptors.FieldDescriptor field) Like Message.getField(Descriptors.FieldDescriptor)
java.lang.Object	getRepeatedField(Descriptors.FieldDescriptor field, int index) Like Message.getRepeatedField(Descriptors.FieldDescriptor,int)
int	getRepeatedFieldCount(Descriptors.FieldDescriptor field) Like Message.getRepeatedFieldCount(Descriptors.FieldDescriptor)
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
boolean	hasField(Descriptors.FieldDescriptor field) Like Message.hasField(Descriptors.FieldDescriptor)
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
Message.Builder	mergeDelimitedFrom(java.io.InputStream input) Like mergeFrom(InputStream), but does not read until EOF.
Message.Builder	mergeDelimitedFrom(java.io.InputStream input, ExtensionRegistry extensionRegistry) Like mergeDelimitedFrom(InputStream) but supporting extensions.
Message.Builder	mergeFrom(byte[] data) Parse data as a message of this type and merge it with the message being built.
Message.Builder	mergeFrom(byte[] data, ExtensionRegistry extensionRegistry) Parse data as a message of this type and merge it with the message being built.
Message.Builder	mergeFrom(byte[] data, int off, int len) Parse data as a message of this type and merge it with the message being built.
Message.Builder	mergeFrom(byte[] data, int off, int len, ExtensionRegistry extensionRegistry) Parse data as a message of this type and merge it with the message being built.
Message.Builder	mergeFrom(ByteString data) Parse data as a message of this type and merge it with the message being built.
Message.Builder	mergeFrom(ByteString data, ExtensionRegistry extensionRegistry) Parse data as a message of this type and merge it with the message being built.
Message.Builder	mergeFrom(CodedInputStream input) Parses a message of this type from the input and merges it with this message, as if using mergeFrom(Message).
Message.Builder	mergeFrom(CodedInputStream input, ExtensionRegistry extensionRegistry) Like mergeFrom(CodedInputStream), but also parses extensions.
Message.Builder	mergeFrom(java.io.InputStream input) Parse a message of this type from input and merge it with the message being built.
Message.Builder	mergeFrom(java.io.InputStream input, ExtensionRegistry extensionRegistry) Parse a message of this type from input and merge it with the message being built.
Message.Builder	mergeFrom(Message other) Merge other into the message being built.
Message.Builder	mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into the UnknownFieldSet for this message.
Message.Builder	newBuilderForField(Descriptors.FieldDescriptor field) Create a Builder for messages of the appropriate type for the given field.
Message.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value) Sets a field to the given value.
Message.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value) Sets an element of a repeated field to the given value.
Message.Builder	setUnknownFields(UnknownFieldSet unknownFields) Set the UnknownFieldSet for this message.

Method Detail

clear

Message.Builder clear()

Resets all fields to their default values.

mergeFrom

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. This is equivalent to the Message::MergeFrom method in C++.

build

Message build()

Construct the final message. Once this is called, the Builder is no longer valid, and calling any other method may throw a NullPointerException. If you need to continue working with the builder after calling build(), clone() it first.

Throws:

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

buildPartial

Message buildPartial()

Like build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

clone

Message.Builder clone()

Clones the Builder.

See Also:

Object.clone()

isInitialized

boolean isInitialized()

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

mergeFrom

Message.Builder mergeFrom(CodedInputStream input)
                          throws java.io.IOException

Parses a message of this type from the input and merges it with this message, as if using mergeFrom(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.
• Parse the message separately using one of the static parseFrom methods, then use mergeFrom(Message) to merge it with this one. parseFrom will throw an InvalidProtocolBufferException (an IOException) if some required fields are missing.
• 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.

Throws:

java.io.IOException

mergeFrom

Message.Builder mergeFrom(CodedInputStream input,
                          ExtensionRegistry extensionRegistry)
                          throws java.io.IOException

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

Throws:

java.io.IOException

getDescriptorForType

Descriptors.Descriptor getDescriptorForType()

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

getDefaultInstanceForType

Message getDefaultInstanceForType()

Get the message's type's default instance. See Message.getDefaultInstanceForType().

getAllFields

java.util.Map<Descriptors.FieldDescriptor,java.lang.Object> getAllFields()

Like Message.getAllFields(). The returned map may or may not reflect future changes to the builder. Either way, the returned map is itself unmodifiable.

newBuilderForField

Message.Builder newBuilderForField(Descriptors.FieldDescriptor field)

Create a Builder for messages of the appropriate type for the given field. Messages built with this can then be passed to setField(), setRepeatedField(), or addRepeatedField().

hasField

boolean hasField(Descriptors.FieldDescriptor field)

Like Message.hasField(Descriptors.FieldDescriptor)

getField

java.lang.Object getField(Descriptors.FieldDescriptor field)

Like Message.getField(Descriptors.FieldDescriptor)

setField

Message.Builder setField(Descriptors.FieldDescriptor field,
                         java.lang.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.

clearField

Message.Builder clearField(Descriptors.FieldDescriptor field)

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

getRepeatedFieldCount

int getRepeatedFieldCount(Descriptors.FieldDescriptor field)

Like Message.getRepeatedFieldCount(Descriptors.FieldDescriptor)

getRepeatedField

java.lang.Object getRepeatedField(Descriptors.FieldDescriptor field,
                                  int index)

Like Message.getRepeatedField(Descriptors.FieldDescriptor,int)

setRepeatedField

Message.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                 int index,
                                 java.lang.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.

Throws:

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

addRepeatedField

Message.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                 java.lang.Object value)

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

Throws:

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

getUnknownFields

UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

setUnknownFields

Message.Builder setUnknownFields(UnknownFieldSet unknownFields)

Set the UnknownFieldSet for this message.

mergeUnknownFields

Message.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Merge some unknown fields into the UnknownFieldSet for this message.

mergeFrom

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

Throws:

InvalidProtocolBufferException

mergeFrom

Message.Builder mergeFrom(ByteString data,
                          ExtensionRegistry 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,ExtensionRegistry).

Throws:

InvalidProtocolBufferException

mergeFrom

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

Throws:

InvalidProtocolBufferException

mergeFrom

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

Throws:

InvalidProtocolBufferException

mergeFrom

Message.Builder mergeFrom(byte[] data,
                          ExtensionRegistry 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,ExtensionRegistry).

Throws:

InvalidProtocolBufferException

mergeFrom

Message.Builder mergeFrom(byte[] data,
                          int off,
                          int len,
                          ExtensionRegistry 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,ExtensionRegistry).

Throws:

InvalidProtocolBufferException

mergeFrom

Message.Builder mergeFrom(java.io.InputStream input)
                          throws java.io.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 Message.writeDelimitedTo(OutputStream) to write your message and mergeDelimitedFrom(InputStream) to read it.

Despite usually reading the entire input, this does not close the stream.

Throws:

java.io.IOException

mergeFrom

Message.Builder mergeFrom(java.io.InputStream input,
                          ExtensionRegistry extensionRegistry)
                          throws java.io.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,ExtensionRegistry).

Throws:

java.io.IOException

mergeDelimitedFrom

Message.Builder mergeDelimitedFrom(java.io.InputStream input)
                                   throws java.io.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 Message.writeDelimitedTo(OutputStream) to write messages in this format.

Throws:

java.io.IOException

mergeDelimitedFrom

Message.Builder mergeDelimitedFrom(java.io.InputStream input,
                                   ExtensionRegistry extensionRegistry)
                                   throws java.io.IOException

Like mergeDelimitedFrom(InputStream) but supporting extensions.

Throws:

java.io.IOException