com.google.protobuf

Class GeneratedMessage.ExtendableMessage<MessageType extends 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, java.io.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 GeneratedMessageLite.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/interfaces inherited from class com.google.protobuf.GeneratedMessage

GeneratedMessage.Builder<BuilderType extends GeneratedMessage.Builder>, 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>

Method Summary

Modifier and Type	Method and Description
java.util.Map<Descriptors.FieldDescriptor,java.lang.Object>	getAllFields() Returns a collection of all the fields in this message which are set and their corresponding values.
java.util.Map<Descriptors.FieldDescriptor,java.lang.Object>	getAllFieldsRaw() Returns a collection of all the fields in this message which are set and their corresponding values.
<Type> Type	getExtension(ExtensionLite<MessageType,java.util.List<Type>> extensionLite, int index) Get one element of a repeated extension.
<Type> Type	getExtension(ExtensionLite<MessageType,Type> extensionLite) Get the value of an extension.
<Type> int	getExtensionCount(ExtensionLite<MessageType,java.util.List<Type>> extensionLite) Get the number of elements in a repeated extension.
java.lang.Object	getField(Descriptors.FieldDescriptor field) Obtains the value of the given field, or the default value if it is not set.
java.lang.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(ExtensionLite<MessageType,Type> extensionLite) 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.

Methods inherited from class com.google.protobuf.GeneratedMessage

getDescriptorForType, getOneofFieldDescriptor, getParserForType, getSerializedSize, getUnknownFields, hasOneof, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, writeTo

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashCode, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Method Detail

hasExtension

public final <Type> boolean hasExtension(ExtensionLite<MessageType,Type> extensionLite)

Check if a singular extension is present.

Specified by:

hasExtension in interface GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>

getExtensionCount

public final <Type> int getExtensionCount(ExtensionLite<MessageType,java.util.List<Type>> extensionLite)

Get the number of elements in a repeated extension.

Specified by:

getExtensionCount in interface GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>

getExtension

public final <Type> Type getExtension(ExtensionLite<MessageType,Type> extensionLite)

Get the value of an extension.

Specified by:

getExtension in interface GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>

getExtension

public final <Type> Type getExtension(ExtensionLite<MessageType,java.util.List<Type>> extensionLite,
                                      int index)

Get one element of a repeated extension.

Specified by:

getExtension in interface GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>

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()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage

getAllFields

public java.util.Map<Descriptors.FieldDescriptor,java.lang.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.

Specified by:

getAllFields in interface MessageOrBuilder

Overrides:

getAllFields in class GeneratedMessage

getAllFieldsRaw

public java.util.Map<Descriptors.FieldDescriptor,java.lang.Object> getAllFieldsRaw()

Description copied from class: GeneratedMessage

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 GeneratedMessage.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.

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.

Specified by:

hasField in interface MessageOrBuilder

Overrides:

hasField in class GeneratedMessage

getField

public java.lang.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.

Specified by:

getField in interface MessageOrBuilder

Overrides:

getField in class GeneratedMessage

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.

Specified by:

getRepeatedFieldCount in interface MessageOrBuilder

Overrides:

getRepeatedFieldCount in class GeneratedMessage

getRepeatedField

public java.lang.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.

Specified by:

getRepeatedField in interface MessageOrBuilder

Overrides:

getRepeatedField in class GeneratedMessage