Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
com.google.protobuf.GeneratedMessage.ExtendableMessage< MessageType extends ExtendableMessage > Class Template Referenceabstract
Inheritance diagram for com.google.protobuf.GeneratedMessage.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.GeneratedMessage
Descriptor getDescriptorForType ()
 
FieldDescriptor getOneofFieldDescriptor (final OneofDescriptor oneof)
 
Parser<? extends GeneratedMessage > 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.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

 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
 
- Protected Member Functions inherited from com.google.protobuf.GeneratedMessage
 GeneratedMessage ()
 
 GeneratedMessage (Builder<?> builder)
 
abstract FieldAccessorTable internalGetFieldAccessorTable ()
 
MapField internalGetMapField (int fieldNumber)
 
abstract Message.Builder newBuilderForType (BuilderParent parent)
 
Message.Builder newBuilderForType (final AbstractMessage.BuilderParent parent)
 
boolean parseUnknownField (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 Public Member Functions inherited from com.google.protobuf.GeneratedMessage
static< ContainingType extends Message, Type > GeneratedExtension< ContainingType, Type > newFileScopedGeneratedExtension (final Class singularType, final Message defaultInstance)
 
static< ContainingType extends Message, Type > GeneratedExtension< ContainingType, Type > newFileScopedGeneratedExtension (final Class singularType, final Message defaultInstance, final String descriptorOuterClass, final String extensionName)
 
static< ContainingType extends Message, Type > GeneratedExtension< ContainingType, Type > newMessageScopedGeneratedExtension (final Message scope, final int descriptorIndex, final Class singularType, final Message defaultInstance)
 
static< ContainingType extends Message, Type > GeneratedExtension< ContainingType, Type > newMessageScopedGeneratedExtension (final Message scope, final String name, final Class singularType, final Message defaultInstance)
 
- Static Protected Member Functions inherited from com.google.protobuf.GeneratedMessage
static int computeStringSize (final int fieldNumber, final Object value)
 
static int computeStringSizeNoTag (final Object value)
 
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 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.GeneratedMessage
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.GeneratedMessage
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 823 of file GeneratedMessage.java.

Constructor & Destructor Documentation

◆ ExtendableMessage() [1/2]

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

Definition at line 832 of file GeneratedMessage.java.

◆ ExtendableMessage() [2/2]

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

Definition at line 836 of file GeneratedMessage.java.

Member Function Documentation

◆ extensionsAreInitialized()

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

Called by subclasses to check if all extensions are initialized.

Definition at line 962 of file GeneratedMessage.java.

◆ extensionsSerializedSize()

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

Called by subclasses to compute the size of extensions.

Definition at line 1054 of file GeneratedMessage.java.

◆ extensionsSerializedSizeAsMessageSet()

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

Definition at line 1057 of file GeneratedMessage.java.

◆ getAllFields()

Map<FieldDescriptor, Object> com.google.protobuf.GeneratedMessage.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.GeneratedMessage.

Definition at line 1069 of file GeneratedMessage.java.

◆ getAllFieldsRaw()

Map<FieldDescriptor, Object> com.google.protobuf.GeneratedMessage.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.GeneratedMessage.

Definition at line 1077 of file GeneratedMessage.java.

◆ getExtension() [1/6]

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

◆ getExtension() [2/6]

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

Get the value of an extension.

Definition at line 939 of file GeneratedMessage.java.

◆ getExtension() [3/6]

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

◆ getExtension() [4/6]

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

Get the value of an extension.

Definition at line 880 of file GeneratedMessage.java.

◆ getExtension() [5/6]

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

◆ getExtension() [6/6]

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

Get the value of an extension.

Definition at line 944 of file GeneratedMessage.java.

◆ getExtensionCount() [1/3]

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

Get the number of elements in a repeated extension.

Definition at line 927 of file GeneratedMessage.java.

◆ getExtensionCount() [2/3]

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

Get the number of elements in a repeated extension.

Definition at line 868 of file GeneratedMessage.java.

◆ getExtensionCount() [3/3]

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

Get the number of elements in a repeated extension.

Definition at line 933 of file GeneratedMessage.java.

◆ getExtensionFields()

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

Definition at line 1064 of file GeneratedMessage.java.

◆ getField()

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

Reimplemented from com.google.protobuf.GeneratedMessage.

Definition at line 1095 of file GeneratedMessage.java.

◆ getRepeatedField()

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

Reimplemented from com.google.protobuf.GeneratedMessage.

Definition at line 1128 of file GeneratedMessage.java.

◆ getRepeatedFieldCount()

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

Reimplemented from com.google.protobuf.GeneratedMessage.

Definition at line 1118 of file GeneratedMessage.java.

◆ hasExtension() [1/3]

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

Check if a singular extension is present.

Definition at line 916 of file GeneratedMessage.java.

◆ hasExtension() [2/3]

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

Check if a singular extension is present.

Definition at line 858 of file GeneratedMessage.java.

◆ hasExtension() [3/3]

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

Check if a singular extension is present.

Definition at line 921 of file GeneratedMessage.java.

◆ hasField()

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

Reimplemented from com.google.protobuf.GeneratedMessage.

Definition at line 1085 of file GeneratedMessage.java.

◆ isInitialized()

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

Definition at line 967 of file GeneratedMessage.java.

◆ makeExtensionsImmutable()

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

Used by parsing constructors in generated classes.

Reimplemented from com.google.protobuf.GeneratedMessage.

Definition at line 987 of file GeneratedMessage.java.

◆ newExtensionWriter()

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

Definition at line 1046 of file GeneratedMessage.java.

◆ newMessageSetExtensionWriter()

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

Definition at line 1049 of file GeneratedMessage.java.

◆ parseUnknownField()

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

Definition at line 972 of file GeneratedMessage.java.

◆ verifyContainingType()

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

Definition at line 1138 of file GeneratedMessage.java.

◆ verifyExtensionContainingType()

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

Definition at line 842 of file GeneratedMessage.java.

Member Data Documentation

◆ extensions

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

Definition at line 830 of file GeneratedMessage.java.

◆ serialVersionUID

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

Definition at line 828 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