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

Classes

class  ExtensionWriter
 

Public Member Functions

Map< FieldDescriptor, Object > getAllFields ()
 
Map< FieldDescriptor, Object > getAllFieldsRaw ()
 
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 ()
 
- Public Member Functions inherited from com.google.protobuf.GeneratedMessageV3
Descriptor getDescriptorForType ()
 
FieldDescriptor getOneofFieldDescriptor (final OneofDescriptor oneof)
 
Parser<? extends GeneratedMessageV3 > getParserForType ()
 
int getSerializedSize ()
 
UnknownFieldSet getUnknownFields ()
 
boolean hasOneof (final OneofDescriptor oneof)
 
void writeTo (final CodedOutputStream output) throws IOException
 
- Public Member Functions inherited from com.google.protobuf.AbstractMessage
boolean equals (final Object other)
 
List< String > findInitializationErrors ()
 
String getInitializationErrorString ()
 
int hashCode ()
 
final String toString ()
 
- Public Member Functions inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >
byte[] toByteArray ()
 
ByteString toByteString ()
 
void writeDelimitedTo (final OutputStream output) throws IOException
 
void writeTo (final OutputStream output) throws IOException
 
- Public Member Functions inherited from com.google.protobuf.Message
Builder newBuilderForType ()
 
Builder toBuilder ()
 
- Public Member Functions inherited from com.google.protobuf.MessageOrBuilder
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)
 
boolean hasField (Descriptors.FieldDescriptor field)
 
boolean hasOneof (Descriptors.OneofDescriptor oneof)
 
- Public Member Functions inherited from com.google.protobuf.GeneratedMessageV3.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

 ExtendableMessage ()
 
 ExtendableMessage (ExtendableBuilder< MessageType, ?> builder)
 
boolean extensionsAreInitialized ()
 
int extensionsSerializedSize ()
 
int extensionsSerializedSizeAsMessageSet ()
 
Map< FieldDescriptor, Object > getExtensionFields ()
 
void makeExtensionsImmutable ()
 
ExtensionWriter newExtensionWriter ()
 
ExtensionWriter newMessageSetExtensionWriter ()
 
boolean parseUnknownField (CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) throws IOException
 
boolean parseUnknownFieldProto3 (CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) throws IOException
 
- Protected Member Functions inherited from com.google.protobuf.GeneratedMessageV3
 GeneratedMessageV3 ()
 
 GeneratedMessageV3 (Builder<?> builder)
 
abstract FieldAccessorTable internalGetFieldAccessorTable ()
 
MapField internalGetMapField (int fieldNumber)
 
void mergeFromAndMakeImmutableInternal (CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
 
abstract Message.Builder newBuilderForType (BuilderParent parent)
 
Message.Builder newBuilderForType (final AbstractMessage.BuilderParent parent)
 
Object newInstance (UnusedPrivateParameter unused)
 
boolean parseUnknownField (CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) throws IOException
 
boolean parseUnknownFieldProto3 (CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) throws IOException
 
Object writeReplace () throws ObjectStreamException
 
- Protected Member Functions inherited from com.google.protobuf.AbstractMessage
Message.Builder newBuilderForType (BuilderParent parent)
 

Private Member Functions

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

Private Attributes

final FieldSet< FieldDescriptor > extensions
 

Static Private Attributes

static final long serialVersionUID = 1L
 

Additional Inherited Members

- Static Protected Member Functions inherited from com.google.protobuf.GeneratedMessageV3
static boolean canUseUnsafe ()
 
static int computeStringSize (final int fieldNumber, final Object value)
 
static int computeStringSizeNoTag (final Object value)
 
static BooleanList emptyBooleanList ()
 
static DoubleList emptyDoubleList ()
 
static FloatList emptyFloatList ()
 
static IntList emptyIntList ()
 
static LongList emptyLongList ()
 
static BooleanList mutableCopy (BooleanList list)
 
static DoubleList mutableCopy (DoubleList list)
 
static FloatList mutableCopy (FloatList list)
 
static IntList mutableCopy (IntList list)
 
static LongList mutableCopy (LongList list)
 
static BooleanList newBooleanList ()
 
static DoubleList newDoubleList ()
 
static FloatList newFloatList ()
 
static IntList newIntList ()
 
static LongList newLongList ()
 
static< M extends Message > M parseDelimitedWithIOException (Parser< M > parser, InputStream input) throws IOException
 
static< M extends Message > M parseDelimitedWithIOException (Parser< M > parser, InputStream input, ExtensionRegistryLite extensions) throws IOException
 
static< M extends Message > M parseWithIOException (Parser< M > parser, CodedInputStream input) throws IOException
 
static< M extends Message > M parseWithIOException (Parser< M > parser, CodedInputStream input, ExtensionRegistryLite extensions) throws IOException
 
static< M extends Message > M parseWithIOException (Parser< M > parser, InputStream input) throws IOException
 
static< M extends Message > M parseWithIOException (Parser< M > parser, InputStream input, ExtensionRegistryLite extensions) throws IOException
 
static< V > void serializeBooleanMapTo (CodedOutputStream out, MapField< Boolean, V > field, MapEntry< Boolean, V > defaultEntry, int fieldNumber) throws IOException
 
static< V > void serializeIntegerMapTo (CodedOutputStream out, MapField< Integer, V > field, MapEntry< Integer, V > defaultEntry, int fieldNumber) throws IOException
 
static< V > void serializeLongMapTo (CodedOutputStream out, MapField< Long, V > field, MapEntry< Long, V > defaultEntry, int fieldNumber) throws IOException
 
static< V > void serializeStringMapTo (CodedOutputStream out, MapField< String, V > field, MapEntry< String, V > defaultEntry, int fieldNumber) throws IOException
 
static void writeString (CodedOutputStream output, final int fieldNumber, final Object value) throws IOException
 
static void writeStringNoTag (CodedOutputStream output, final Object value) throws IOException
 
- Static Protected Member Functions inherited from com.google.protobuf.AbstractMessage
static int hashBoolean (boolean b)
 
static int hashEnum (EnumLite e)
 
static int hashEnumList (List<? extends EnumLite > list)
 
static int hashFields (int hash, Map< FieldDescriptor, Object > map)
 
static int hashLong (long n)
 
- Static Protected Member Functions inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.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 void checkByteStringIsUtf8 (ByteString byteString) throws IllegalArgumentException
 
- Protected Attributes inherited from com.google.protobuf.GeneratedMessageV3
UnknownFieldSet unknownFields
 
- Protected Attributes inherited from com.google.protobuf.AbstractMessage
int memoizedSize = -1
 
- Protected Attributes inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >
int memoizedHashCode = 0
 
- Static Protected Attributes inherited from com.google.protobuf.GeneratedMessageV3
static boolean alwaysUseFieldBuilders = false
 

Detailed Description

Generated message classes 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. "has", "get", and "getCount" – 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 = getFoo();
int i = foo.getExtension(MyProto.bar);

See also ExtendableBuilder.

Definition at line 971 of file GeneratedMessageV3.java.

Constructor & Destructor Documentation

◆ ExtendableMessage() [1/2]

com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.ExtendableMessage ( )
inlineprotected

Definition at line 980 of file GeneratedMessageV3.java.

◆ ExtendableMessage() [2/2]

com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.ExtendableMessage ( ExtendableBuilder< MessageType, ?>  builder)
inlineprotected

Definition at line 984 of file GeneratedMessageV3.java.

Member Function Documentation

◆ extensionsAreInitialized()

boolean com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.extensionsAreInitialized ( )
inlineprotected

Called by subclasses to check if all extensions are initialized.

Definition at line 1110 of file GeneratedMessageV3.java.

◆ extensionsSerializedSize()

int com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.extensionsSerializedSize ( )
inlineprotected

Called by subclasses to compute the size of extensions.

Definition at line 1215 of file GeneratedMessageV3.java.

◆ extensionsSerializedSizeAsMessageSet()

int com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.extensionsSerializedSizeAsMessageSet ( )
inlineprotected

Definition at line 1218 of file GeneratedMessageV3.java.

◆ getAllFields()

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

Returns a collection of all the fields in this message which are set and their corresponding values. A singular ("required" or "optional") field is set iff hasField() returns true for that field. A "repeated" field is set iff getRepeatedFieldCount() is greater than zero. The values are exactly what would be returned by calling getField(Descriptors.FieldDescriptor) for each field. The map is guaranteed to be a sorted map, so iterating over it will return fields in order by field number.
If this is for a builder, the returned map may or may not reflect future changes to the builder. Either way, the returned map is itself unmodifiable.

Reimplemented from com.google.protobuf.GeneratedMessageV3.

Definition at line 1230 of file GeneratedMessageV3.java.

◆ getAllFieldsRaw()

Map<FieldDescriptor, Object> com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.getAllFieldsRaw ( )
inline

Returns a collection of all the fields in this message which are set and their corresponding values. A singular ("required" or "optional") field is set iff hasField() returns true for that field. A "repeated" field is set iff getRepeatedFieldCount() is greater than zero. The values are exactly what would be returned by calling getFieldRaw(Descriptors.FieldDescriptor) for each field. The map is guaranteed to be a sorted map, so iterating over it will return fields in order by field number.

Reimplemented from com.google.protobuf.GeneratedMessageV3.

Definition at line 1238 of file GeneratedMessageV3.java.

◆ getExtension() [1/6]

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

Get one element of a repeated extension.

Definition at line 1098 of file GeneratedMessageV3.java.

◆ getExtension() [2/6]

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

Get the value of an extension.

Definition at line 1087 of file GeneratedMessageV3.java.

◆ getExtension() [3/6]

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

Get one element of a repeated extension.

Definition at line 1052 of file GeneratedMessageV3.java.

◆ getExtension() [4/6]

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

Get the value of an extension.

Definition at line 1028 of file GeneratedMessageV3.java.

◆ getExtension() [5/6]

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

Get one element of a repeated extension.

Definition at line 1104 of file GeneratedMessageV3.java.

◆ getExtension() [6/6]

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

Get the value of an extension.

Definition at line 1092 of file GeneratedMessageV3.java.

◆ getExtensionCount() [1/3]

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

Get the number of elements in a repeated extension.

Definition at line 1075 of file GeneratedMessageV3.java.

◆ getExtensionCount() [2/3]

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

Get the number of elements in a repeated extension.

Definition at line 1016 of file GeneratedMessageV3.java.

◆ getExtensionCount() [3/3]

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

Get the number of elements in a repeated extension.

Definition at line 1081 of file GeneratedMessageV3.java.

◆ getExtensionFields()

Map<FieldDescriptor, Object> com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.getExtensionFields ( )
inlineprotected

Definition at line 1225 of file GeneratedMessageV3.java.

◆ getField()

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

Reimplemented from com.google.protobuf.GeneratedMessageV3.

Definition at line 1256 of file GeneratedMessageV3.java.

◆ getRepeatedField()

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

Reimplemented from com.google.protobuf.GeneratedMessageV3.

Definition at line 1289 of file GeneratedMessageV3.java.

◆ getRepeatedFieldCount()

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

Reimplemented from com.google.protobuf.GeneratedMessageV3.

Definition at line 1279 of file GeneratedMessageV3.java.

◆ hasExtension() [1/3]

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

Check if a singular extension is present.

Definition at line 1064 of file GeneratedMessageV3.java.

◆ hasExtension() [2/3]

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

Check if a singular extension is present.

Definition at line 1006 of file GeneratedMessageV3.java.

◆ hasExtension() [3/3]

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

Check if a singular extension is present.

Definition at line 1069 of file GeneratedMessageV3.java.

◆ hasField()

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

Reimplemented from com.google.protobuf.GeneratedMessageV3.

Definition at line 1246 of file GeneratedMessageV3.java.

◆ isInitialized()

boolean com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.isInitialized ( )
inline

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

See also: MessageOrBuilder#getInitializationErrorString()

Reimplemented from com.google.protobuf.GeneratedMessageV3.

Definition at line 1115 of file GeneratedMessageV3.java.

◆ makeExtensionsImmutable()

void com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.makeExtensionsImmutable ( )
inlineprotected

Used by parsing constructors in generated classes.

Reimplemented from com.google.protobuf.GeneratedMessageV3.

Definition at line 1148 of file GeneratedMessageV3.java.

◆ newExtensionWriter()

ExtensionWriter com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.newExtensionWriter ( )
inlineprotected

Definition at line 1207 of file GeneratedMessageV3.java.

◆ newMessageSetExtensionWriter()

ExtensionWriter com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.newMessageSetExtensionWriter ( )
inlineprotected

Definition at line 1210 of file GeneratedMessageV3.java.

◆ parseUnknownField()

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

Definition at line 1120 of file GeneratedMessageV3.java.

◆ parseUnknownFieldProto3()

boolean com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.parseUnknownFieldProto3 ( CodedInputStream  input,
UnknownFieldSet.Builder  unknownFields,
ExtensionRegistryLite  extensionRegistry,
int  tag 
) throws IOException
inlineprotected

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

Definition at line 1135 of file GeneratedMessageV3.java.

◆ verifyContainingType()

void com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.verifyContainingType ( final FieldDescriptor  field)
inlineprivate

Definition at line 1299 of file GeneratedMessageV3.java.

◆ verifyExtensionContainingType()

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

Definition at line 990 of file GeneratedMessageV3.java.

Member Data Documentation

◆ extensions

final FieldSet<FieldDescriptor> com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.extensions
private

Definition at line 978 of file GeneratedMessageV3.java.

◆ serialVersionUID

final long com.google.protobuf.GeneratedMessageV3.ExtendableMessage< MessageType extends ExtendableMessage >.serialVersionUID = 1L
staticprivate

Definition at line 976 of file GeneratedMessageV3.java.

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

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