com.google.protobuf
Class AbstractMessage.Builder<BuilderType extends AbstractMessage.Builder>

java.lang.Object
  com.google.protobuf.AbstractMessage.Builder<BuilderType>

All Implemented Interfaces:

Message.Builder, java.lang.Cloneable

Direct Known Subclasses:

DynamicMessage.Builder, GeneratedMessage.Builder

Enclosing class:

AbstractMessage

public abstract static class AbstractMessage.Builder<BuilderType extends AbstractMessage.Builder>
extends java.lang.Object
implements Message.Builder

A partial implementation of the Message.Builder interface which implements as many methods of that interface as possible in terms of other methods.

Constructor Summary

AbstractMessage.Builder()

Method Summary

BuilderType	clear() Resets all fields to their default values.
abstract BuilderType	clone() Clones the Builder.
BuilderType	mergeDelimitedFrom(java.io.InputStream input) Like Message.Builder.mergeFrom(InputStream), but does not read until EOF.
BuilderType	mergeDelimitedFrom(java.io.InputStream input, ExtensionRegistry extensionRegistry) Like Message.Builder.mergeDelimitedFrom(InputStream) but supporting extensions.
BuilderType	mergeFrom(byte[] data) Parse data as a message of this type and merge it with the message being built.
BuilderType	mergeFrom(byte[] data, ExtensionRegistry extensionRegistry) Parse data as a message of this type and merge it with the message being built.
BuilderType	mergeFrom(byte[] data, int off, int len) Parse data as a message of this type and merge it with the message being built.
BuilderType	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.
BuilderType	mergeFrom(ByteString data) Parse data as a message of this type and merge it with the message being built.
BuilderType	mergeFrom(ByteString data, ExtensionRegistry extensionRegistry) Parse data as a message of this type and merge it with the message being built.
BuilderType	mergeFrom(CodedInputStream input) Parses a message of this type from the input and merges it with this message, as if using Message.Builder.mergeFrom(Message).
BuilderType	mergeFrom(CodedInputStream input, ExtensionRegistry extensionRegistry) Like Message.Builder.mergeFrom(CodedInputStream), but also parses extensions.
BuilderType	mergeFrom(java.io.InputStream input) Parse a message of this type from input and merge it with the message being built.
BuilderType	mergeFrom(java.io.InputStream input, ExtensionRegistry extensionRegistry) Parse a message of this type from input and merge it with the message being built.
BuilderType	mergeFrom(Message other) Merge other into the message being built.
BuilderType	mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into the UnknownFieldSet for this message.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

addRepeatedField, build, buildPartial, clearField, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, isInitialized, newBuilderForField, setField, setRepeatedField, setUnknownFields

Constructor Detail

AbstractMessage.Builder

public AbstractMessage.Builder()

Method Detail

clone

public abstract BuilderType clone()

Description copied from interface: Message.Builder

Clones the Builder.

Specified by:

clone in interface Message.Builder

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

clear

public BuilderType clear()

Description copied from interface: Message.Builder

Resets all fields to their default values.

Specified by:

clear in interface Message.Builder

mergeFrom

public BuilderType mergeFrom(Message other)

Description copied from interface: Message.Builder

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

Specified by:

mergeFrom in interface Message.Builder

mergeFrom

public BuilderType mergeFrom(CodedInputStream input)
                                                      throws java.io.IOException

Description copied from interface: Message.Builder

Parses a message of this type from the input and merges it with this message, as if using Message.Builder.mergeFrom(Message).

Warning: This does not verify that all required fields are present in the input message. If you call Message.Builder.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 Message.Builder.isInitialized() to verify that all required fields are set before building.
• Parse the message separately using one of the static parseFrom methods, then use Message.Builder.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.

Specified by:

mergeFrom in interface Message.Builder

Throws:

java.io.IOException

mergeFrom

public BuilderType mergeFrom(CodedInputStream input,
                             ExtensionRegistry extensionRegistry)
                                                      throws java.io.IOException

Description copied from interface: Message.Builder

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

Specified by:

mergeFrom in interface Message.Builder

Throws:

java.io.IOException

mergeUnknownFields

public BuilderType mergeUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Merge some unknown fields into the UnknownFieldSet for this message.

Specified by:

mergeUnknownFields in interface Message.Builder

mergeFrom

public BuilderType mergeFrom(ByteString data)
                                                      throws InvalidProtocolBufferException

Description copied from interface: Message.Builder

Parse data as a message of this type and merge it with the message being built. This is just a small wrapper around Message.Builder.mergeFrom(CodedInputStream).

Specified by:

mergeFrom in interface Message.Builder

Throws:

InvalidProtocolBufferException

mergeFrom

public BuilderType mergeFrom(ByteString data,
                             ExtensionRegistry extensionRegistry)
                                                      throws InvalidProtocolBufferException

Description copied from interface: Message.Builder

Parse data as a message of this type and merge it with the message being built. This is just a small wrapper around Message.Builder.mergeFrom(CodedInputStream,ExtensionRegistry).

Specified by:

mergeFrom in interface Message.Builder

Throws:

InvalidProtocolBufferException

mergeFrom

public BuilderType mergeFrom(byte[] data)
                                                      throws InvalidProtocolBufferException

Description copied from interface: Message.Builder

Parse data as a message of this type and merge it with the message being built. This is just a small wrapper around Message.Builder.mergeFrom(CodedInputStream).

Specified by:

mergeFrom in interface Message.Builder

Throws:

InvalidProtocolBufferException

mergeFrom

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

Description copied from interface: Message.Builder

Parse data as a message of this type and merge it with the message being built. This is just a small wrapper around Message.Builder.mergeFrom(CodedInputStream).

Specified by:

mergeFrom in interface Message.Builder

Throws:

InvalidProtocolBufferException

mergeFrom

public BuilderType mergeFrom(byte[] data,
                             ExtensionRegistry extensionRegistry)
                                                      throws InvalidProtocolBufferException

Description copied from interface: Message.Builder

Parse data as a message of this type and merge it with the message being built. This is just a small wrapper around Message.Builder.mergeFrom(CodedInputStream,ExtensionRegistry).

Specified by:

mergeFrom in interface Message.Builder

Throws:

InvalidProtocolBufferException

mergeFrom

public BuilderType mergeFrom(byte[] data,
                             int off,
                             int len,
                             ExtensionRegistry extensionRegistry)
                                                      throws InvalidProtocolBufferException

Description copied from interface: Message.Builder

Parse data as a message of this type and merge it with the message being built. This is just a small wrapper around Message.Builder.mergeFrom(CodedInputStream,ExtensionRegistry).

Specified by:

mergeFrom in interface Message.Builder

Throws:

InvalidProtocolBufferException

mergeFrom

public BuilderType mergeFrom(java.io.InputStream input)
                                                      throws java.io.IOException

Description copied from interface: Message.Builder

Parse a message of this type from input and merge it with the message being built. This is just a small wrapper around Message.Builder.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 Message.Builder.mergeDelimitedFrom(InputStream) to read it.

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

Specified by:

mergeFrom in interface Message.Builder

Throws:

java.io.IOException

mergeFrom

public BuilderType mergeFrom(java.io.InputStream input,
                             ExtensionRegistry extensionRegistry)
                                                      throws java.io.IOException

Description copied from interface: Message.Builder

Parse a message of this type from input and merge it with the message being built. This is just a small wrapper around Message.Builder.mergeFrom(CodedInputStream,ExtensionRegistry).

Specified by:

mergeFrom in interface Message.Builder

Throws:

java.io.IOException

mergeDelimitedFrom

public BuilderType mergeDelimitedFrom(java.io.InputStream input,
                                      ExtensionRegistry extensionRegistry)
                                                               throws java.io.IOException

Description copied from interface: Message.Builder

Like Message.Builder.mergeDelimitedFrom(InputStream) but supporting extensions.

Specified by:

mergeDelimitedFrom in interface Message.Builder

Throws:

java.io.IOException

mergeDelimitedFrom

public BuilderType mergeDelimitedFrom(java.io.InputStream input)
                                                               throws java.io.IOException

Description copied from interface: Message.Builder

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

Specified by:

mergeDelimitedFrom in interface Message.Builder

Throws:

java.io.IOException