Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType > Class Template Referenceabstract
Inheritance diagram for com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >:
Inheritance graph
[legend]

Classes

class  BuilderParentImpl
 

Public Member Functions

BuilderType addRepeatedField (final FieldDescriptor field, final Object value)
 
BuilderType clear ()
 
BuilderType clearField (final FieldDescriptor field)
 
BuilderType clearOneof (final OneofDescriptor oneof)
 
BuilderType clone ()
 
Map< FieldDescriptor, Object > getAllFields ()
 
Descriptor getDescriptorForType ()
 
Object getField (final FieldDescriptor field)
 
Message.Builder getFieldBuilder (final FieldDescriptor field)
 
FieldDescriptor getOneofFieldDescriptor (final OneofDescriptor oneof)
 
Object getRepeatedField (final FieldDescriptor field, final int index)
 
Message.Builder getRepeatedFieldBuilder (final FieldDescriptor field, int index)
 
int getRepeatedFieldCount (final FieldDescriptor field)
 
final UnknownFieldSet getUnknownFields ()
 
boolean hasField (final FieldDescriptor field)
 
boolean hasOneof (final OneofDescriptor oneof)
 
boolean isInitialized ()
 
BuilderType mergeUnknownFields (final UnknownFieldSet unknownFields)
 
Message.Builder newBuilderForField (final FieldDescriptor field)
 
BuilderType setField (final FieldDescriptor field, final Object value)
 
BuilderType setRepeatedField (final FieldDescriptor field, final int index, final Object value)
 
BuilderType setUnknownFields (final UnknownFieldSet unknownFields)
 
- Public Member Functions inherited from com.google.protobuf.AbstractMessage.Builder< BuilderType >
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 ()
 

Protected Member Functions

 Builder ()
 
 Builder (BuilderParent builderParent)
 
BuilderParent getParentForChildren ()
 
abstract FieldAccessorTable internalGetFieldAccessorTable ()
 
MapField internalGetMapField (int fieldNumber)
 
MapField internalGetMutableMapField (int fieldNumber)
 
boolean isClean ()
 
void markClean ()
 
void onBuilt ()
 
final void onChanged ()
 
BuilderType setUnknownFieldsProto3 (final UnknownFieldSet unknownFields)
 
- Protected Member Functions inherited from com.google.protobuf.AbstractMessage.Builder< BuilderType >
BuilderType internalMergeFrom (AbstractMessageLite other)
 

Private Member Functions

Map< FieldDescriptor, Object > getAllFieldsMutable ()
 
BuilderType setUnknownFieldsInternal (final UnknownFieldSet unknownFields)
 

Private Attributes

BuilderParent builderParent
 
boolean isClean
 
BuilderParentImpl meAsParent
 
UnknownFieldSet unknownFields
 

Additional Inherited Members

- Static Protected Member Functions inherited from com.google.protobuf.AbstractMessage.Builder< BuilderType >
static UninitializedMessageException newUninitializedMessageException (Message message)
 

Detailed Description

Definition at line 532 of file GeneratedMessageV3.java.

Constructor & Destructor Documentation

◆ Builder() [1/2]

com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.Builder ( )
inlineprotected

Definition at line 546 of file GeneratedMessageV3.java.

◆ Builder() [2/2]

com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.Builder ( BuilderParent  builderParent)
inlineprotected

Definition at line 550 of file GeneratedMessageV3.java.

Member Function Documentation

◆ addRepeatedField()

BuilderType com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.addRepeatedField ( final FieldDescriptor  field,
final Object  value 
)
inline

◆ clear()

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

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Reimplemented in com.google.protobuf.GeneratedMessageV3.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.

Definition at line 599 of file GeneratedMessageV3.java.

◆ clearField()

BuilderType com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.clearField ( final FieldDescriptor  field)
inline

◆ clearOneof()

BuilderType com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.clearOneof ( final OneofDescriptor  oneof)
inline

Definition at line 721 of file GeneratedMessageV3.java.

◆ clone()

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

Definition at line 587 of file GeneratedMessageV3.java.

◆ getAllFields()

Map<FieldDescriptor, Object> com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getAllFields ( )
inline

◆ getAllFieldsMutable()

Map<FieldDescriptor, Object> com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getAllFieldsMutable ( )
inlineprivate

Internal helper which returns a mutable map.

Definition at line 623 of file GeneratedMessageV3.java.

◆ getDescriptorForType()

Descriptor com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getDescriptorForType ( )
inline

Definition at line 613 of file GeneratedMessageV3.java.

◆ getField()

Object com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getField ( final FieldDescriptor  field)
inline

◆ getFieldBuilder()

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

Definition at line 671 of file GeneratedMessageV3.java.

◆ getOneofFieldDescriptor()

FieldDescriptor com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getOneofFieldDescriptor ( final OneofDescriptor  oneof)
inline

Definition at line 687 of file GeneratedMessageV3.java.

◆ getParentForChildren()

BuilderParent com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getParentForChildren ( )
inlineprotected

Gets the BuilderParent for giving to our children.

Returns
The builder parent for our children.

Definition at line 833 of file GeneratedMessageV3.java.

◆ getRepeatedField()

Object com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getRepeatedField ( final FieldDescriptor  field,
final int  index 
)
inline

◆ getRepeatedFieldBuilder()

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

Definition at line 676 of file GeneratedMessageV3.java.

◆ getRepeatedFieldCount()

int com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getRepeatedFieldCount ( final FieldDescriptor  field)
inline

◆ getUnknownFields()

final UnknownFieldSet com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.getUnknownFields ( )
inline

Definition at line 812 of file GeneratedMessageV3.java.

◆ hasField()

boolean com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.hasField ( final FieldDescriptor  field)
inline

◆ hasOneof()

boolean com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.hasOneof ( final OneofDescriptor  oneof)
inline

Definition at line 682 of file GeneratedMessageV3.java.

◆ internalGetFieldAccessorTable()

abstract FieldAccessorTable com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.internalGetFieldAccessorTable ( )
abstractprotected

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

◆ internalGetMapField()

MapField com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.internalGetMapField ( int  fieldNumber)
inlineprotected

Gets the map field with the given field number. This method should be overridden in the generated message class if the message contains map fields.

Unlike other field types, reflection support for map fields can't be implemented based on generated public API because we need to access a map field as a list in reflection API but the generated API only allows us to access it as a map. This method returns the underlying map field directly and thus enables us to access the map field as a list.

Definition at line 865 of file GeneratedMessageV3.java.

◆ internalGetMutableMapField()

MapField com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.internalGetMutableMapField ( int  fieldNumber)
inlineprotected

Like internalGetMapField but return a mutable version.

Definition at line 874 of file GeneratedMessageV3.java.

◆ isClean()

boolean com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.isClean ( )
inlineprotected

Gets whether invalidations are needed

Returns
whether invalidations are needed

Definition at line 582 of file GeneratedMessageV3.java.

◆ isInitialized()

boolean com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.isInitialized ( )
inline

◆ markClean()

void com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.markClean ( )
inlineprotected

Called by the subclass or a builder to notify us that a message was built and may be cached and therefore invalidations are needed.

Definition at line 573 of file GeneratedMessageV3.java.

◆ mergeUnknownFields()

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

Definition at line 772 of file GeneratedMessageV3.java.

◆ newBuilderForField()

Message.Builder com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.newBuilderForField ( final FieldDescriptor  field)
inline

◆ onBuilt()

void com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.onBuilt ( )
inlineprotected

Called by the subclass when a message is built.

Definition at line 562 of file GeneratedMessageV3.java.

◆ onChanged()

final void com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.onChanged ( )
inlineprotected

Called when a the builder or one of its nested children has changed and any parent should be notified of its invalidation.

Definition at line 844 of file GeneratedMessageV3.java.

◆ setField()

BuilderType com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.setField ( final FieldDescriptor  field,
final Object  value 
)
inline

◆ setRepeatedField()

BuilderType com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.setRepeatedField ( final FieldDescriptor  field,
final int  index,
final Object  value 
)
inline

◆ setUnknownFields()

BuilderType com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.setUnknownFields ( final UnknownFieldSet  unknownFields)
inline

Definition at line 759 of file GeneratedMessageV3.java.

◆ setUnknownFieldsInternal()

BuilderType com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.setUnknownFieldsInternal ( final UnknownFieldSet  unknownFields)
inlineprivate

Definition at line 752 of file GeneratedMessageV3.java.

◆ setUnknownFieldsProto3()

BuilderType com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.setUnknownFieldsProto3 ( final UnknownFieldSet  unknownFields)
inlineprotected

This method is obsolete, but we must retain it for compatibility with older generated code.

Definition at line 767 of file GeneratedMessageV3.java.

Member Data Documentation

◆ builderParent

BuilderParent com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.builderParent
private

Definition at line 535 of file GeneratedMessageV3.java.

◆ isClean

boolean com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.isClean
private

Definition at line 541 of file GeneratedMessageV3.java.

◆ meAsParent

BuilderParentImpl com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.meAsParent
private

Definition at line 537 of file GeneratedMessageV3.java.

◆ unknownFields

UnknownFieldSet com.google.protobuf.GeneratedMessageV3.Builder< BuilderType extends Builder< BuilderType >.unknownFields
private
Initial value:
=
UnknownFieldSet.getDefaultInstance()

Definition at line 543 of file GeneratedMessageV3.java.


The documentation for this class was generated from the following file:
google::protobuf::python::cmessage::UnknownFieldSet
static PyObject * UnknownFieldSet(CMessage *self)
Definition: python/google/protobuf/pyext/message.cc:2501


libaditof
Author(s):
autogenerated on Wed May 21 2025 02:07:07