GeneratedMessage.ExtendableMessage

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType>

All Implemented Interfaces:

GeneratedMessage.ExtendableMessageOrBuilder<MessageType>, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

Direct Known Subclasses:

DescriptorProtos.EnumOptions, DescriptorProtos.EnumValueOptions, DescriptorProtos.FieldOptions, DescriptorProtos.FileOptions, DescriptorProtos.MessageOptions, DescriptorProtos.MethodOptions, DescriptorProtos.ServiceOptions

Enclosing class:

GeneratedMessage
```
public abstract static class GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>
extends GeneratedMessage
implements GeneratedMessage.ExtendableMessageOrBuilder<MessageType>
```
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 GeneratedMessage.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 GeneratedMessage.ExtendableBuilder.
See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`protected class`	`GeneratedMessage.ExtendableMessage.ExtensionWriter` Used by subclasses to serialize extensions.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
GeneratedMessage.Builder<BuilderType extends GeneratedMessage.Builder>, GeneratedMessage.BuilderParent, GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>

Field Summary
- Fields inherited from class com.google.protobuf.GeneratedMessage
  alwaysUseFieldBuilders
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor and Description
`protected`	`ExtendableMessage()`
`protected`	`ExtendableMessage(GeneratedMessage.ExtendableBuilder<MessageType,?> builder)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`extensionsAreInitialized()` Called by subclasses to check if all extensions are initialized.
`protected int`	`extensionsSerializedSize()` Called by subclasses to compute the size of extensions.
`protected int`	`extensionsSerializedSizeAsMessageSet()`
`Map<Descriptors.FieldDescriptor,Object>`	`getAllFields()` Returns a collection of all the fields in this message which are set and their corresponding values.
`<Type> Type`	`getExtension(Extension<MessageType,List<Type>> extension, int index)` Get one element of a repeated extension.
`<Type> Type`	`getExtension(Extension<MessageType,Type> extension)` Get the value of an extension.
`<Type> int`	`getExtensionCount(Extension<MessageType,List<Type>> extension)` Get the number of elements in a repeated extension.
`protected Map<Descriptors.FieldDescriptor,Object>`	`getExtensionFields()`
`Object`	`getField(Descriptors.FieldDescriptor field)` Obtains the value of the given field, or the default value if it is not set.
`Object`	`getRepeatedField(Descriptors.FieldDescriptor field, int index)` Gets an element of a repeated field.
`int`	`getRepeatedFieldCount(Descriptors.FieldDescriptor field)` Gets the number of elements of a repeated field.
`<Type> boolean`	`hasExtension(Extension<MessageType,Type> extension)` Check if a singular extension is present.
`boolean`	`hasField(Descriptors.FieldDescriptor field)` Returns true if the given field is set.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`protected void`	`makeExtensionsImmutable()` Used by parsing constructors in generated classes.
`protected GeneratedMessage.ExtendableMessage.ExtensionWriter`	`newExtensionWriter()`
`protected GeneratedMessage.ExtendableMessage.ExtensionWriter`	`newMessageSetExtensionWriter()`
`protected boolean`	`parseUnknownField(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag)` Called by subclasses to parse an unknown field.

Methods inherited from class com.google.protobuf.GeneratedMessage
getDescriptorForType, getOneofFieldDescriptor, getParserForType, getUnknownFields, hasOneof, internalGetFieldAccessorTable, newBuilderForType, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, writeReplace

Methods inherited from class com.google.protobuf.AbstractMessage
equals, findInitializationErrors, getInitializationErrorString, getSerializedSize, hashCode, hashFields, toString, writeTo

Methods inherited from class com.google.protobuf.AbstractMessageLite
checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder
getDefaultInstanceForType

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getDescriptorForType, getInitializationErrorString, getOneofFieldDescriptor, getUnknownFields, hasOneof

Methods inherited from interface com.google.protobuf.Message
newBuilderForType, toBuilder

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Constructor Detail
  - ExtendableMessage
```
protected ExtendableMessage()
```
  - ExtendableMessage
```
protected ExtendableMessage(GeneratedMessage.ExtendableBuilder<MessageType,?> builder)
```
- Method Detail
  - hasExtension
```
public final <Type> boolean hasExtension(Extension<MessageType,Type> extension)
```
    Check if a singular extension is present.
  - getExtensionCount
```
public final <Type> int getExtensionCount(Extension<MessageType,List<Type>> extension)
```
    Get the number of elements in a repeated extension.
  - getExtension
```
public final <Type> Type getExtension(Extension<MessageType,Type> extension)
```
    Get the value of an extension.
  - getExtension
```
public final <Type> Type getExtension(Extension<MessageType,List<Type>> extension,
                                      int index)
```
    Get one element of a repeated extension.
  - extensionsAreInitialized
```
protected boolean extensionsAreInitialized()
```
    Called by subclasses to check if all extensions are initialized.
  - isInitialized
```
public boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
  - parseUnknownField
```
protected boolean parseUnknownField(CodedInputStream input,
                                    UnknownFieldSet.Builder unknownFields,
                                    ExtensionRegistryLite extensionRegistry,
                                    int tag)
                             throws IOException
```
    Description copied from class: GeneratedMessage
    
    Called by subclasses to parse an unknown field.
    
    Overrides:
    
    parseUnknownField in class GeneratedMessage
    
    Returns:
    
    true unless the tag is an end-group tag.
    
    Throws:
    
    IOException
  - makeExtensionsImmutable
```
protected void makeExtensionsImmutable()
```
    Used by parsing constructors in generated classes.
  - newExtensionWriter
```
protected GeneratedMessage.ExtendableMessage.ExtensionWriter newExtensionWriter()
```
  - newMessageSetExtensionWriter
```
protected GeneratedMessage.ExtendableMessage.ExtensionWriter newMessageSetExtensionWriter()
```
  - extensionsSerializedSize
```
protected int extensionsSerializedSize()
```
    Called by subclasses to compute the size of extensions.
  - extensionsSerializedSizeAsMessageSet
```
protected int extensionsSerializedSizeAsMessageSet()
```
  - getExtensionFields
```
protected Map<Descriptors.FieldDescriptor,Object> getExtensionFields()
```
  - getAllFields
```
public Map<Descriptors.FieldDescriptor,Object> getAllFields()
```
    Description copied from interface: MessageOrBuilder
    
    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 MessageOrBuilder.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.
  - hasField
```
public boolean hasField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: MessageOrBuilder
    
    Returns true if the given field is set. This is exactly equivalent to calling the generated "has" accessor method corresponding to the field.
  - getField
```
public Object getField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: MessageOrBuilder
    
    Obtains the value of the given field, or the default value if it is not set. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned. For repeated fields, a java.util.List is returned.
  - getRepeatedFieldCount
```
public int getRepeatedFieldCount(Descriptors.FieldDescriptor field)
```
    Description copied from interface: MessageOrBuilder
    
    Gets the number of elements of a repeated field. This is exactly equivalent to calling the generated "Count" accessor method corresponding to the field.
  - getRepeatedField
```
public Object getRepeatedField(Descriptors.FieldDescriptor field,
                               int index)
```
    Description copied from interface: MessageOrBuilder
    
    Gets an element of a repeated field. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned.

Class GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>

Nested Class Summary

Nested Classes

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Constructor Summary

Constructors

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message

Methods inherited from interface com.google.protobuf.MessageLite

Constructor Detail

ExtendableMessage

ExtendableMessage

Method Detail

hasExtension

getExtensionCount

getExtension

getExtension

extensionsAreInitialized

isInitialized

parseUnknownField

makeExtensionsImmutable

newExtensionWriter

newMessageSetExtensionWriter

extensionsSerializedSize

extensionsSerializedSizeAsMessageSet

getExtensionFields

getAllFields

hasField

getField

getRepeatedFieldCount

getRepeatedField