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

Inheritance diagram for com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >:

Public Member Functions
BuilderType	clear ()
BuilderType	clearOneof (OneofDescriptor oneof)
BuilderType	clone ()
List< String >	findInitializationErrors ()
Message.Builder	getFieldBuilder (final FieldDescriptor field)
String	getInitializationErrorString ()
FieldDescriptor	getOneofFieldDescriptor (OneofDescriptor oneof)
Message.Builder	getRepeatedFieldBuilder (final FieldDescriptor field, int index)
boolean	hasOneof (OneofDescriptor oneof)
boolean	mergeDelimitedFrom (final InputStream input) throws IOException
boolean	mergeDelimitedFrom (final InputStream input, final ExtensionRegistryLite extensionRegistry) throws IOException
BuilderType	mergeFrom (final byte[] data) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final byte[] data, final ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final byte[] data, final int off, final int len) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final byte[] data, final int off, final int len, final ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final ByteString data) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final ByteString data, final ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
BuilderType	mergeFrom (final CodedInputStream input) throws IOException
BuilderType	mergeFrom (final CodedInputStream input, final ExtensionRegistryLite extensionRegistry) throws IOException
BuilderType	mergeFrom (final InputStream input) throws IOException
BuilderType	mergeFrom (final InputStream input, final ExtensionRegistryLite extensionRegistry) throws IOException
BuilderType	mergeFrom (final Message other)
BuilderType	mergeUnknownFields (final UnknownFieldSet unknownFields)
String	toString ()
Public Member Functions inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >
BuilderType	mergeFrom (final MessageLite other)
Public Member Functions inherited from com.google.protobuf.MessageLiteOrBuilder
boolean	isInitialized ()
Public Member Functions inherited from com.google.protobuf.Message.Builder
Builder	addRepeatedField (Descriptors.FieldDescriptor field, Object value)
Message	build ()
Message	buildPartial ()
Builder	clearField (Descriptors.FieldDescriptor field)
Builder	clearOneof (Descriptors.OneofDescriptor oneof)
Descriptors.Descriptor	getDescriptorForType ()
Builder	getFieldBuilder (Descriptors.FieldDescriptor field)
Builder	getRepeatedFieldBuilder (Descriptors.FieldDescriptor field, int index)
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.MessageOrBuilder
Map< Descriptors.FieldDescriptor, Object >	getAllFields ()
Message	getDefaultInstanceForType ()
Object	getField (Descriptors.FieldDescriptor field)
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)

Protected Member Functions
BuilderType	internalMergeFrom (AbstractMessageLite other)
Protected Member Functions inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >
abstract BuilderType	internalMergeFrom (MessageType message)

Static Protected Member Functions
static UninitializedMessageException	newUninitializedMessageException (Message message)
Static Protected Member Functions inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >
static< T > void	addAll (final Iterable< T > values, final Collection<? super T > list)
static< T > void	addAll (final Iterable< T > values, final List<? super T > list)
static UninitializedMessageException	newUninitializedMessageException (MessageLite message)

Detailed Description

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

Definition at line 318 of file AbstractMessage.java.

Member Function Documentation

clear()

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.clear ( )

inline

Resets all fields to their default values.

Implements com.google.protobuf.Message.Builder.

Definition at line 347 of file AbstractMessage.java.

clearOneof()

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.clearOneof ( OneofDescriptor  oneof )

inline

TODO(jieluo): Clear it when all subclasses have implemented this method.

Definition at line 342 of file AbstractMessage.java.

clone()

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.clone ( )

inline

Clones the Builder.

See also

Object::clone()

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 324 of file AbstractMessage.java.

findInitializationErrors()

List<String> com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.findInitializationErrors ( )

inline

Returns a list of field paths (e.g. "foo.bar.baz") of required fields which are not set in this message. You should call MessageLiteOrBuilder#isInitialized() first to check if there are any missing fields, as that method is likely to be much faster than this one even when the message is fully-initialized.

Implements com.google.protobuf.MessageOrBuilder.

Definition at line 355 of file AbstractMessage.java.

getFieldBuilder()

Message.Builder com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.getFieldBuilder ( final FieldDescriptor  field )

inline

Definition at line 458 of file AbstractMessage.java.

getInitializationErrorString()

String com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.getInitializationErrorString ( )

inline

Returns a comma-delimited list of required fields which are not set in this message object. You should call MessageLiteOrBuilder#isInitialized() first to check if there are any missing fields, as that method is likely to be much faster than this one even when the message is fully-initialized.

Implements com.google.protobuf.MessageOrBuilder.

Definition at line 360 of file AbstractMessage.java.

getOneofFieldDescriptor()

FieldDescriptor com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.getOneofFieldDescriptor ( OneofDescriptor  oneof )

inline

TODO(jieluo): Clear it when all subclasses have implemented this method.

Definition at line 336 of file AbstractMessage.java.

getRepeatedFieldBuilder()

Message.Builder com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.getRepeatedFieldBuilder ( final FieldDescriptor  field, int  index  )

inline

Definition at line 464 of file AbstractMessage.java.

hasOneof()

boolean com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.hasOneof ( OneofDescriptor  oneof )

inline

TODO(jieluo): Clear it when all subclasses have implemented this method.

Definition at line 330 of file AbstractMessage.java.

internalMergeFrom()

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.internalMergeFrom ( AbstractMessageLite  other )

inlineprotected

Definition at line 365 of file AbstractMessage.java.

mergeDelimitedFrom() [1/2]

boolean com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeDelimitedFrom ( final InputStream  input ) throws IOException

inline

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.

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 573 of file AbstractMessage.java.

mergeDelimitedFrom() [2/2]

boolean com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeDelimitedFrom ( final InputStream  input, final ExtensionRegistryLite  extensionRegistry  ) throws IOException

inline

Like mergeDelimitedFrom(InputStream) but supporting extensions.

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 578 of file AbstractMessage.java.

mergeFrom() [1/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final byte[]  data ) throws InvalidProtocolBufferException

inline

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

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 535 of file AbstractMessage.java.

mergeFrom() [2/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final byte[]  data, final ExtensionRegistryLite  extensionRegistry  ) throws InvalidProtocolBufferException

inline

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

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 546 of file AbstractMessage.java.

mergeFrom() [3/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final byte[]  data, final int  off, final int  len  ) throws InvalidProtocolBufferException

inline

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

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 540 of file AbstractMessage.java.

mergeFrom() [4/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final byte[]  data, final int  off, final int  len, final ExtensionRegistryLite  extensionRegistry  ) throws InvalidProtocolBufferException

inline

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

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 552 of file AbstractMessage.java.

mergeFrom() [5/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final ByteString  data ) throws InvalidProtocolBufferException

inline

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

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 523 of file AbstractMessage.java.

mergeFrom() [6/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final ByteString  data, final ExtensionRegistryLite  extensionRegistry  ) throws InvalidProtocolBufferException

inline

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

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 528 of file AbstractMessage.java.

mergeFrom() [7/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final CodedInputStream  input ) throws IOException

inline

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.

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 419 of file AbstractMessage.java.

mergeFrom() [8/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final CodedInputStream  input, final ExtensionRegistryLite  extensionRegistry  ) throws IOException

inline

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.

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 424 of file AbstractMessage.java.

mergeFrom() [9/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final InputStream  input ) throws IOException

inline

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

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 562 of file AbstractMessage.java.

mergeFrom() [10/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final InputStream  input, final ExtensionRegistryLite  extensionRegistry  ) throws IOException

inline

Parse a message of this type from

input 

and merge it with the message being built. This is just a small wrapper around {}. this

Reimplemented from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >.Builder< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends Builder< MessageType, BuilderType >.

Definition at line 567 of file AbstractMessage.java.

mergeFrom() [11/11]

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeFrom ( final Message  other )

inline

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

Implements com.google.protobuf.Message.Builder.

Definition at line 370 of file AbstractMessage.java.

mergeUnknownFields()

BuilderType com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.mergeUnknownFields ( final UnknownFieldSet  unknownFields )

inline

Merge some unknown fields into the UnknownFieldSet for this message.

Implements com.google.protobuf.Message.Builder.

Definition at line 451 of file AbstractMessage.java.

newUninitializedMessageException()

static UninitializedMessageException com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.newUninitializedMessageException ( Message  message )

inlinestaticprotected

Construct an UninitializedMessageException reporting missing fields in the given message.

Definition at line 475 of file AbstractMessage.java.

toString()

String com.google.protobuf.AbstractMessage.Builder< BuilderType extends Builder< BuilderType >.toString ( )

inline

Definition at line 470 of file AbstractMessage.java.

---

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

• AbstractMessage.java