Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType > Class Template Referenceabstract
Inheritance diagram for com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >:
Inheritance graph
[legend]

Public Member Functions

final< Type > BuilderType addExtension (final Extension< MessageType, List< Type >> extension, final Type value)
 
final< Type > BuilderType addExtension (final ExtensionLite< MessageType, List< Type >> extensionLite, final Type value)
 
BuilderType addRepeatedField (final FieldDescriptor field, final Object value)
 
BuilderType clear ()
 
final< Type > BuilderType clearExtension (final Extension< MessageType, ?> extension)
 
final< Type > BuilderType clearExtension (final ExtensionLite< MessageType, ?> extensionLite)
 
BuilderType clearField (final FieldDescriptor field)
 
BuilderType clone ()
 
Map< FieldDescriptor, Object > getAllFields ()
 
final< Type > Type getExtension (final Extension< MessageType, List< Type >> extension, final int index)
 
final< Type > Type getExtension (final Extension< MessageType, Type > extension)
 
final< Type > Type getExtension (final ExtensionLite< MessageType, List< Type >> extensionLite, final int index)
 
final< Type > Type getExtension (final ExtensionLite< MessageType, Type > extensionLite)
 
final< Type > Type getExtension (final GeneratedExtension< MessageType, List< Type >> extension, final int index)
 
final< Type > Type getExtension (final GeneratedExtension< MessageType, Type > extension)
 
final< Type > int getExtensionCount (final Extension< MessageType, List< Type >> extension)
 
final< Type > int getExtensionCount (final ExtensionLite< MessageType, List< Type >> extensionLite)
 
final< Type > int getExtensionCount (final GeneratedExtension< MessageType, List< Type >> extension)
 
Object getField (final FieldDescriptor field)
 
Object getRepeatedField (final FieldDescriptor field, final int index)
 
int getRepeatedFieldCount (final FieldDescriptor field)
 
final< Type > boolean hasExtension (final Extension< MessageType, Type > extension)
 
final< Type > boolean hasExtension (final ExtensionLite< MessageType, Type > extensionLite)
 
final< Type > boolean hasExtension (final GeneratedExtension< MessageType, Type > extension)
 
boolean hasField (final FieldDescriptor field)
 
boolean isInitialized ()
 
final< Type > BuilderType setExtension (final Extension< MessageType, List< Type >> extension, final int index, final Type value)
 
final< Type > BuilderType setExtension (final Extension< MessageType, Type > extension, final Type value)
 
final< Type > BuilderType setExtension (final ExtensionLite< MessageType, List< Type >> extensionLite, final int index, final Type value)
 
final< Type > BuilderType setExtension (final ExtensionLite< MessageType, Type > extensionLite, final Type value)
 
BuilderType setField (final FieldDescriptor field, final Object value)
 
BuilderType setRepeatedField (final FieldDescriptor field, final int index, final Object value)
 
- Public Member Functions inherited from com.google.protobuf.GeneratedMessage.Builder< BuilderType >
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.GeneratedMessage.ExtendableMessageOrBuilder< MessageType >
Message getDefaultInstanceForType ()
 
< Type > Type getExtension (Extension< MessageType, List< Type >> extension, int index)
 
< Type > Type getExtension (Extension< MessageType, Type > extension)
 
< Type > Type getExtension (ExtensionLite< MessageType, List< Type >> extension, int index)
 
< Type > Type getExtension (ExtensionLite< MessageType, Type > extension)
 
< Type > Type getExtension (GeneratedExtension< MessageType, List< Type >> extension, int index)
 
< Type > Type getExtension (GeneratedExtension< MessageType, Type > extension)
 
< Type > int getExtensionCount (Extension< MessageType, List< Type >> extension)
 
< Type > int getExtensionCount (ExtensionLite< MessageType, List< Type >> extension)
 
< Type > int getExtensionCount (GeneratedExtension< MessageType, List< Type >> extension)
 
< Type > boolean hasExtension (Extension< MessageType, Type > extension)
 
< Type > boolean hasExtension (ExtensionLite< MessageType, Type > extension)
 
< Type > boolean hasExtension (GeneratedExtension< MessageType, Type > extension)
 

Protected Member Functions

 ExtendableBuilder ()
 
 ExtendableBuilder (BuilderParent parent)
 
boolean extensionsAreInitialized ()
 
final void mergeExtensionFields (final ExtendableMessage other)
 
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.GeneratedMessage.Builder< BuilderType >
 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
 

Private Member Functions

FieldSet< FieldDescriptorbuildExtensions ()
 
void ensureExtensionsIsMutable ()
 
void verifyContainingType (final FieldDescriptor field)
 
void verifyExtensionContainingType (final Extension< MessageType, ?> extension)
 

Private Attributes

FieldSet< FieldDescriptorextensions = FieldSet.emptySet()
 

Detailed Description

Generated message builders for message types that contain extension ranges subclass this.

This class implements type-safe accessors for extensions. They implement all the same operations that you can do with normal fields – e.g. "get", "set", and "add" – but for extensions. The extensions are identified using instances of the class GeneratedExtension; the protocol compiler generates a static instance of this class for every extension in its input. Through the magic of generics, all is made type-safe.

For example, imagine you have the

.proto

file:

option java_class = "MyProto";
message Foo {
  extensions 1000 to max;
}
extend Foo {
  optional int32 bar;
}

Then you might write code like:

MyProto.Foo foo =
  MyProto.Foo.newBuilder()
    .setExtension(MyProto.bar, 123)
    .build();

See also ExtendableMessage.

Definition at line 1184 of file GeneratedMessage.java.

Constructor & Destructor Documentation

◆ ExtendableBuilder() [1/2]

com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.ExtendableBuilder ( )
inlineprotected

Definition at line 1192 of file GeneratedMessage.java.

◆ ExtendableBuilder() [2/2]

com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.ExtendableBuilder ( BuilderParent  parent)
inlineprotected

Definition at line 1194 of file GeneratedMessage.java.

Member Function Documentation

◆ addExtension() [1/2]

final<Type> BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.addExtension ( final Extension< MessageType, List< Type >>  extension,
final Type  value 
)
inline

Append a value to a repeated extension.

Definition at line 1418 of file GeneratedMessage.java.

◆ addExtension() [2/2]

final<Type> BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.addExtension ( final ExtensionLite< MessageType, List< Type >>  extensionLite,
final Type  value 
)
inline

Append a value to a repeated extension.

Definition at line 1323 of file GeneratedMessage.java.

◆ addRepeatedField()

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

Definition at line 1576 of file GeneratedMessage.java.

◆ buildExtensions()

FieldSet<FieldDescriptor> com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.buildExtensions ( )
inlineprivate

Called by the build code path to create a copy of the extensions for building the message.

Definition at line 1447 of file GeneratedMessage.java.

◆ clear()

BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.clear ( )
inline

Definition at line 1205 of file GeneratedMessage.java.

◆ clearExtension() [1/2]

final<Type> BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.clearExtension ( final Extension< MessageType, ?>  extension)
inline

Clear an extension.

Definition at line 1428 of file GeneratedMessage.java.

◆ clearExtension() [2/2]

final<Type> BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.clearExtension ( final ExtensionLite< MessageType, ?>  extensionLite)
inline

Clear an extension.

Definition at line 1338 of file GeneratedMessage.java.

◆ clearField()

BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.clearField ( final FieldDescriptor  field)
inline

Definition at line 1549 of file GeneratedMessage.java.

◆ clone()

BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.clone ( )
inline

Definition at line 1214 of file GeneratedMessage.java.

◆ ensureExtensionsIsMutable()

void com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.ensureExtensionsIsMutable ( )
inlineprivate

Definition at line 1218 of file GeneratedMessage.java.

◆ extensionsAreInitialized()

boolean com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.extensionsAreInitialized ( )
inlineprotected

Called by subclasses to check if all extensions are initialized.

Definition at line 1439 of file GeneratedMessage.java.

◆ getAllFields()

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

Definition at line 1476 of file GeneratedMessage.java.

◆ getExtension() [1/6]

final<Type> Type com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtension ( final Extension< MessageType, List< Type >>  extension,
final int  index 
)
inline

Get the value of an extension.

Definition at line 1385 of file GeneratedMessage.java.

◆ getExtension() [2/6]

final<Type> Type com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtension ( final Extension< MessageType, Type extension)
inline

Get the value of an extension.

Definition at line 1374 of file GeneratedMessage.java.

◆ getExtension() [3/6]

final<Type> Type com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtension ( final ExtensionLite< MessageType, List< Type >>  extensionLite,
final int  index 
)
inline

Get one element of a repeated extension.

Definition at line 1282 of file GeneratedMessage.java.

◆ getExtension() [4/6]

final<Type> Type com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtension ( final ExtensionLite< MessageType, Type extensionLite)
inline

Get the value of an extension.

Definition at line 1259 of file GeneratedMessage.java.

◆ getExtension() [5/6]

final<Type> Type com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtension ( final GeneratedExtension< MessageType, List< Type >>  extension,
final int  index 
)
inline

Get the value of an extension.

Definition at line 1391 of file GeneratedMessage.java.

◆ getExtension() [6/6]

final<Type> Type com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtension ( final GeneratedExtension< MessageType, Type extension)
inline

Get the value of an extension.

Definition at line 1379 of file GeneratedMessage.java.

◆ getExtensionCount() [1/3]

final<Type> int com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtensionCount ( final Extension< MessageType, List< Type >>  extension)
inline

Get the number of elements in a repeated extension.

Definition at line 1362 of file GeneratedMessage.java.

◆ getExtensionCount() [2/3]

final<Type> int com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtensionCount ( final ExtensionLite< MessageType, List< Type >>  extensionLite)
inline

Get the number of elements in a repeated extension.

Definition at line 1248 of file GeneratedMessage.java.

◆ getExtensionCount() [3/3]

final<Type> int com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getExtensionCount ( final GeneratedExtension< MessageType, List< Type >>  extension)
inline

Get the number of elements in a repeated extension.

Definition at line 1368 of file GeneratedMessage.java.

◆ getField()

Object com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getField ( final FieldDescriptor  field)
inline

Definition at line 1483 of file GeneratedMessage.java.

◆ getRepeatedField()

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

Definition at line 1514 of file GeneratedMessage.java.

◆ getRepeatedFieldCount()

int com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.getRepeatedFieldCount ( final FieldDescriptor  field)
inline

Definition at line 1504 of file GeneratedMessage.java.

◆ hasExtension() [1/3]

final<Type> boolean com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.hasExtension ( final Extension< MessageType, Type extension)
inline

Check if a singular extension is present.

Definition at line 1351 of file GeneratedMessage.java.

◆ hasExtension() [2/3]

final<Type> boolean com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.hasExtension ( final ExtensionLite< MessageType, Type extensionLite)
inline

Check if a singular extension is present.

Definition at line 1239 of file GeneratedMessage.java.

◆ hasExtension() [3/3]

final<Type> boolean com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.hasExtension ( final GeneratedExtension< MessageType, Type extension)
inline

Check if a singular extension is present.

Definition at line 1356 of file GeneratedMessage.java.

◆ hasField()

boolean com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.hasField ( final FieldDescriptor  field)
inline

Definition at line 1525 of file GeneratedMessage.java.

◆ isInitialized()

boolean com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.isInitialized ( )
inline

Definition at line 1453 of file GeneratedMessage.java.

◆ mergeExtensionFields()

final void com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.mergeExtensionFields ( final ExtendableMessage  other)
inlineprotected

Definition at line 1589 of file GeneratedMessage.java.

◆ parseUnknownField()

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

Called by subclasses to parse an unknown field or an extension.

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

Definition at line 1462 of file GeneratedMessage.java.

◆ setExtension() [1/4]

final<Type> BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.setExtension ( final Extension< MessageType, List< Type >>  extension,
final int  index,
final Type  value 
)
inline

Set the value of one element of a repeated extension.

Definition at line 1406 of file GeneratedMessage.java.

◆ setExtension() [2/4]

final<Type> BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.setExtension ( final Extension< MessageType, Type extension,
final Type  value 
)
inline

Set the value of an extension.

Definition at line 1396 of file GeneratedMessage.java.

◆ setExtension() [3/4]

final<Type> BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.setExtension ( final ExtensionLite< MessageType, List< Type >>  extensionLite,
final int  index,
final Type  value 
)
inline

Set the value of one element of a repeated extension.

Definition at line 1307 of file GeneratedMessage.java.

◆ setExtension() [4/4]

final<Type> BuilderType com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.setExtension ( final ExtensionLite< MessageType, Type extensionLite,
final Type  value 
)
inline

Set the value of an extension.

Definition at line 1293 of file GeneratedMessage.java.

◆ setField()

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

Definition at line 1535 of file GeneratedMessage.java.

◆ setRepeatedField()

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

Definition at line 1562 of file GeneratedMessage.java.

◆ verifyContainingType()

void com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.verifyContainingType ( final FieldDescriptor  field)
inlineprivate

Definition at line 1595 of file GeneratedMessage.java.

◆ verifyExtensionContainingType()

void com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.verifyExtensionContainingType ( final Extension< MessageType, ?>  extension)
inlineprivate

Definition at line 1224 of file GeneratedMessage.java.

Member Data Documentation

◆ extensions

FieldSet<FieldDescriptor> com.google.protobuf.GeneratedMessage.ExtendableBuilder< MessageType extends ExtendableMessage, BuilderType extends ExtendableBuilder< MessageType, BuilderType >.extensions = FieldSet.emptySet()
private

Definition at line 1190 of file GeneratedMessage.java.


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


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