com.google.protobuf.UnknownFieldSet.Builder Class Reference

Inheritance diagram for com.google.protobuf.UnknownFieldSet.Builder:

Public Member Functions
Builder	addField (final int number, final Field field)
Map< Integer, Field >	asMap ()
UnknownFieldSet	build ()
UnknownFieldSet	buildPartial ()
Builder	clear ()
Builder	clearField (final int number)
Builder	clone ()
UnknownFieldSet	getDefaultInstanceForType ()
boolean	hasField (final int number)
boolean	isInitialized ()
boolean	mergeDelimitedFrom (InputStream input) throws IOException
boolean	mergeDelimitedFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
Builder	mergeField (final int number, final Field field)
boolean	mergeFieldFrom (final int tag, final CodedInputStream input) throws IOException
Builder	mergeFrom (byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
Builder	mergeFrom (byte[] data, int off, int len) throws InvalidProtocolBufferException
Builder	mergeFrom (byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
Builder	mergeFrom (ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
Builder	mergeFrom (CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
Builder	mergeFrom (final byte[] data) throws InvalidProtocolBufferException
Builder	mergeFrom (final ByteString data) throws InvalidProtocolBufferException
Builder	mergeFrom (final CodedInputStream input) throws IOException
Builder	mergeFrom (final InputStream input) throws IOException
Builder	mergeFrom (final UnknownFieldSet other)
Builder	mergeFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
Builder	mergeFrom (MessageLite m)
Builder	mergeLengthDelimitedField (final int number, final ByteString value)
Builder	mergeVarintField (final int number, final int value)

Private Member Functions
	Builder ()
Field.Builder	getFieldBuilder (final int number)
void	reinitialize ()

Static Private Member Functions
static Builder	create ()

Private Attributes
Map< Integer, Field >	fields
Field.Builder	lastField
int	lastFieldNumber

Detailed Description

Builder for UnknownFieldSets.

Note that this class maintains Field.Builders for all fields in the set. Thus, adding one element to an existing Field does not require making a copy. This is important for efficient parsing of unknown repeated fields. However, it implies that {}s cannot be constructed independently, nor can two UnknownFieldSet}s share the same Field object. Use UnknownFieldSet#newBuilder() to construct a

Builder 

.

Definition at line 308 of file UnknownFieldSet.java.

Constructor & Destructor Documentation

Builder()

com.google.protobuf.UnknownFieldSet.Builder.Builder ( )

inlineprivate

Definition at line 310 of file UnknownFieldSet.java.

Member Function Documentation

addField()

Builder com.google.protobuf.UnknownFieldSet.Builder.addField ( final int  number, final Field  field  )

inline

Add a field to the

UnknownFieldSet 

. If a field with the same number already exists, it is removed.

Definition at line 491 of file UnknownFieldSet.java.

asMap()

Map<Integer, Field> com.google.protobuf.UnknownFieldSet.Builder.asMap ( )

inline

Get all present

Field 

s as an immutable

Map 

. If more fields are added, the changes may or may not be reflected in this map.

Definition at line 511 of file UnknownFieldSet.java.

build()

UnknownFieldSet com.google.protobuf.UnknownFieldSet.Builder.build ( )

inline

Build the UnknownFieldSet and return it.

Once

build() 

has been called, the

Builder 

will no longer be usable. Calling any method after

build() 

will result in undefined behavior and can cause a

NullPointerException 

to be thrown.

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 358 of file UnknownFieldSet.java.

buildPartial()

UnknownFieldSet com.google.protobuf.UnknownFieldSet.Builder.buildPartial ( )

inline

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.

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 374 of file UnknownFieldSet.java.

clear()

Builder com.google.protobuf.UnknownFieldSet.Builder.clear ( )

inline

Reset the builder to an empty set.

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 401 of file UnknownFieldSet.java.

clearField()

Builder com.google.protobuf.UnknownFieldSet.Builder.clearField ( final int  number )

inline

Clear fields from the set with a given field number.

Definition at line 407 of file UnknownFieldSet.java.

clone()

Builder com.google.protobuf.UnknownFieldSet.Builder.clone ( )

inline

Clones the Builder.

See also

Object::clone()

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 380 of file UnknownFieldSet.java.

create()

static Builder com.google.protobuf.UnknownFieldSet.Builder.create ( )

inlinestaticprivate

Definition at line 320 of file UnknownFieldSet.java.

getDefaultInstanceForType()

UnknownFieldSet com.google.protobuf.UnknownFieldSet.Builder.getDefaultInstanceForType ( )

inline

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the

getDefaultInstance() 

method of generated message classes in that this method is an abstract method of the

MessageLite 

interface whereas

getDefaultInstance() 

is a static method of a specific class. They return the same thing.

Implements com.google.protobuf.MessageLiteOrBuilder.

Definition at line 389 of file UnknownFieldSet.java.

getFieldBuilder()

Field.Builder com.google.protobuf.UnknownFieldSet.Builder.getFieldBuilder ( final int  number )

inlineprivate

Get a field builder for the given field number which includes any values that already exist.

Definition at line 329 of file UnknownFieldSet.java.

hasField()

boolean com.google.protobuf.UnknownFieldSet.Builder.hasField ( final int  number )

inline

Check if the given field number is present in the set.

Definition at line 480 of file UnknownFieldSet.java.

isInitialized()

boolean com.google.protobuf.UnknownFieldSet.Builder.isInitialized ( )

inline

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

See also: MessageOrBuilder#getInitializationErrorString()

Implements com.google.protobuf.MessageLiteOrBuilder.

Definition at line 690 of file UnknownFieldSet.java.

mergeDelimitedFrom() [1/2]

boolean com.google.protobuf.UnknownFieldSet.Builder.mergeDelimitedFrom ( 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.

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 612 of file UnknownFieldSet.java.

mergeDelimitedFrom() [2/2]

boolean com.google.protobuf.UnknownFieldSet.Builder.mergeDelimitedFrom ( InputStream  input, ExtensionRegistryLite  extensionRegistry  ) throws IOException

inline

Like mergeDelimitedFrom(InputStream) but supporting extensions.

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 624 of file UnknownFieldSet.java.

mergeField()

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeField ( final int  number, final Field  field  )

inline

Add a field to the

UnknownFieldSet 

. If a field with the same number already exists, the two are merged.

Definition at line 439 of file UnknownFieldSet.java.

mergeFieldFrom()

boolean com.google.protobuf.UnknownFieldSet.Builder.mergeFieldFrom ( final int  tag, final CodedInputStream  input  ) throws IOException

inline

Parse a single field from

input 

and merge it into this set.

Parameters

tag	The field's tag number, which was already parsed.

Returns

false 

if the tag is an end group tag.

Definition at line 534 of file UnknownFieldSet.java.

mergeFrom() [1/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( byte[]  data, 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

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 660 of file UnknownFieldSet.java.

mergeFrom() [2/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( byte[]  data, int  off, 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

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 645 of file UnknownFieldSet.java.

mergeFrom() [3/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( byte[]  data, int  off, int  len, 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

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 667 of file UnknownFieldSet.java.

mergeFrom() [4/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( ByteString  data, 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

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 638 of file UnknownFieldSet.java.

mergeFrom() [5/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( CodedInputStream  input, 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.

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 631 of file UnknownFieldSet.java.

mergeFrom() [6/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( final byte[]  data ) throws InvalidProtocolBufferException

inline

Parse

data 

as an

UnknownFieldSet 

and merge it with the set being built. This is just a small wrapper around mergeFrom(CodedInputStream).

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 585 of file UnknownFieldSet.java.

mergeFrom() [7/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( final ByteString  data ) throws InvalidProtocolBufferException

inline

Parse

data 

as an

UnknownFieldSet 

and merge it with the set being built. This is just a small wrapper around mergeFrom(CodedInputStream).

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 566 of file UnknownFieldSet.java.

mergeFrom() [8/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( final CodedInputStream  input ) throws IOException

inline

Parse an entire message from

input 

and merge its fields into this set.

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 518 of file UnknownFieldSet.java.

mergeFrom() [9/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( final InputStream  input ) throws IOException

inline

Parse an

UnknownFieldSet 

from

input 

and merge it with the set being built. This is just a small wrapper around mergeFrom(CodedInputStream).

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 604 of file UnknownFieldSet.java.

mergeFrom() [10/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( final UnknownFieldSet  other )

inline

Merge the fields from

other 

into this set. If a field number exists in both sets,

other 

's values for that field will be appended to the values in this set.

Definition at line 426 of file UnknownFieldSet.java.

mergeFrom() [11/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( InputStream  input, 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

Implements com.google.protobuf.MessageLite.Builder.

Definition at line 674 of file UnknownFieldSet.java.

mergeFrom() [12/12]

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeFrom ( MessageLite  other )

inline

Merge

other 

into the message being built.

other 

must have the exact same type as

this 

(i.e.

getClass().equals(getDefaultInstanceForType().getClass()) 

).

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.MessageLite.Builder.

Definition at line 681 of file UnknownFieldSet.java.

mergeLengthDelimitedField()

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeLengthDelimitedField ( final int  number, final ByteString  value  )

inline

Convenience method for merging a length-delimited field.

For use by generated code only.

Definition at line 471 of file UnknownFieldSet.java.

mergeVarintField()

Builder com.google.protobuf.UnknownFieldSet.Builder.mergeVarintField ( final int  number, final int  value  )

inline

Convenience method for merging a new field containing a single varint value. This is used in particular when an unknown enum value is encountered.

Definition at line 458 of file UnknownFieldSet.java.

reinitialize()

void com.google.protobuf.UnknownFieldSet.Builder.reinitialize ( )

inlineprivate

Definition at line 393 of file UnknownFieldSet.java.

Member Data Documentation

fields

Map<Integer, Field> com.google.protobuf.UnknownFieldSet.Builder.fields

private

Definition at line 312 of file UnknownFieldSet.java.

lastField

Field.Builder com.google.protobuf.UnknownFieldSet.Builder.lastField

private

Definition at line 318 of file UnknownFieldSet.java.

lastFieldNumber

int com.google.protobuf.UnknownFieldSet.Builder.lastFieldNumber

private

Definition at line 317 of file UnknownFieldSet.java.

---

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

• UnknownFieldSet.java