Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
com.google.protobuf.GeneratedMessage.Builder< BuilderType extends Builder< BuilderType > Class Template Referenceabstract
Inheritance diagram for com.google.protobuf.GeneratedMessage.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 ()
 
boolean parseUnknownField (final CodedInputStream input, final UnknownFieldSet.Builder unknownFields, final ExtensionRegistryLite extensionRegistry, final int tag) throws IOException
 
- Protected Member Functions inherited from com.google.protobuf.AbstractMessage.Builder< BuilderType >
BuilderType internalMergeFrom (AbstractMessageLite other)
 

Private Member Functions

Map< FieldDescriptor, Object > getAllFieldsMutable ()
 

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 383 of file GeneratedMessage.java.

Constructor & Destructor Documentation

◆ Builder() [1/2]

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

◆ Builder() [2/2]

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

Definition at line 401 of file GeneratedMessage.java.

Member Function Documentation

◆ addRepeatedField()

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

Definition at line 598 of file GeneratedMessage.java.

◆ clear()

BuilderType com.google.protobuf.GeneratedMessage.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.jruby.SentinelOuterClass.Sentinel.Builder.

Definition at line 450 of file GeneratedMessage.java.

◆ clearField()

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

Definition at line 566 of file GeneratedMessage.java.

◆ clearOneof()

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

Definition at line 572 of file GeneratedMessage.java.

◆ clone()

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

Definition at line 438 of file GeneratedMessage.java.

◆ getAllFields()

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

Definition at line 469 of file GeneratedMessage.java.

◆ getAllFieldsMutable()

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

Internal helper which returns a mutable map.

Definition at line 474 of file GeneratedMessage.java.

◆ getDescriptorForType()

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

◆ getField()

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

Definition at line 548 of file GeneratedMessage.java.

◆ getFieldBuilder()

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

Definition at line 522 of file GeneratedMessage.java.

◆ getOneofFieldDescriptor()

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

Definition at line 538 of file GeneratedMessage.java.

◆ getParentForChildren()

BuilderParent com.google.protobuf.GeneratedMessage.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 685 of file GeneratedMessage.java.

◆ getRepeatedField()

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

Definition at line 584 of file GeneratedMessage.java.

◆ getRepeatedFieldBuilder()

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

Definition at line 527 of file GeneratedMessage.java.

◆ getRepeatedFieldCount()

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

Definition at line 578 of file GeneratedMessage.java.

◆ getUnknownFields()

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

Definition at line 652 of file GeneratedMessage.java.

◆ hasField()

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

Definition at line 543 of file GeneratedMessage.java.

◆ hasOneof()

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

Definition at line 533 of file GeneratedMessage.java.

◆ internalGetFieldAccessorTable()

abstract FieldAccessorTable com.google.protobuf.GeneratedMessage.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.

Reimplemented in com.google.protobuf.jruby.SentinelOuterClass.Sentinel.Builder.

◆ internalGetMapField()

MapField com.google.protobuf.GeneratedMessage.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 717 of file GeneratedMessage.java.

◆ internalGetMutableMapField()

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

Like internalGetMapField but return a mutable version.

Definition at line 726 of file GeneratedMessage.java.

◆ isClean()

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

Gets whether invalidations are needed

Returns
whether invalidations are needed

Definition at line 433 of file GeneratedMessage.java.

◆ isInitialized()

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

Definition at line 622 of file GeneratedMessage.java.

◆ markClean()

void com.google.protobuf.GeneratedMessage.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 424 of file GeneratedMessage.java.

◆ mergeUnknownFields()

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

Definition at line 611 of file GeneratedMessage.java.

◆ newBuilderForField()

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

Definition at line 517 of file GeneratedMessage.java.

◆ onBuilt()

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

Called by the subclass when a message is built.

Definition at line 413 of file GeneratedMessage.java.

◆ onChanged()

final void com.google.protobuf.GeneratedMessage.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 696 of file GeneratedMessage.java.

◆ parseUnknownField()

boolean com.google.protobuf.GeneratedMessage.Builder< BuilderType extends Builder< BuilderType >.parseUnknownField ( final CodedInputStream  input,
final UnknownFieldSet.Builder< BuilderType extends Builder< BuilderType >  unknownFields,
final ExtensionRegistryLite  extensionRegistry,
final int  tag 
) throws IOException
inlineprotected

Called by subclasses to parse an unknown field.

Returns
true
unless the tag is an end-group tag.

Definition at line 660 of file GeneratedMessage.java.

◆ setField()

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

Definition at line 560 of file GeneratedMessage.java.

◆ setRepeatedField()

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

Definition at line 590 of file GeneratedMessage.java.

◆ setUnknownFields()

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

Definition at line 604 of file GeneratedMessage.java.

Member Data Documentation

◆ builderParent

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

Definition at line 386 of file GeneratedMessage.java.

◆ isClean

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

Definition at line 392 of file GeneratedMessage.java.

◆ meAsParent

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

Definition at line 388 of file GeneratedMessage.java.

◆ unknownFields

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

Definition at line 394 of file GeneratedMessage.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