Class GeneratedMessageV3.ExtendableMessage<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
- All Implemented Interfaces:
GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT>,Message,MessageLite,MessageLiteOrBuilder,MessageOrBuilder,Serializable
- Direct Known Subclasses:
DescriptorProtos.EnumOptions,DescriptorProtos.EnumValueOptions,DescriptorProtos.ExtensionRangeOptions,DescriptorProtos.FeatureSet,DescriptorProtos.FieldOptions,DescriptorProtos.FileOptions,DescriptorProtos.MessageOptions,DescriptorProtos.MethodOptions,DescriptorProtos.OneofOptions,DescriptorProtos.ServiceOptions
- Enclosing class:
- GeneratedMessageV3
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 GeneratedMessageV3.ExtendableBuilder.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classUsed by subclasses to serialize extensions.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.Builder<BuilderT>>, GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, GeneratedMessageV3.ExtendableMessage<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>, GeneratedMessageV3.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final FieldSet<Descriptors.FieldDescriptor>private static final longFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedprotected -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanCalled by subclasses to check if all extensions are initialized.protected intCalled by subclasses to compute the size of extensions.protected intReturns a collection of all the fields in this message which are set and their corresponding values.Returns a collection of all the fields in this message which are set and their corresponding values.final <T> TgetExtension(Extension<MessageT, List<T>> extension, int index) Get one element of a repeated extension.final <T> TgetExtension(Extension<MessageT, T> extension) Get the value of an extension.final <T> TgetExtension(ExtensionLite<MessageT, List<T>> extensionLite, int index) Get one element of a repeated extension.final <T> TgetExtension(ExtensionLite<MessageT, T> extensionLite) Get the value of an extension.final <T> TgetExtension(GeneratedMessage.GeneratedExtension<MessageT, List<T>> extension, int index) Get one element of a repeated extension.final <T> TgetExtension(GeneratedMessage.GeneratedExtension<MessageT, T> extension) Get the value of an extension.final <T> intgetExtensionCount(Extension<MessageT, List<T>> extension) Get the number of elements in a repeated extension.final <T> intgetExtensionCount(ExtensionLite<MessageT, List<T>> extensionLite) Get the number of elements in a repeated extension.final <T> intgetExtensionCount(GeneratedMessage.GeneratedExtension<MessageT, List<T>> extension) Get the number of elements in a repeated extension.protected Map<Descriptors.FieldDescriptor,Object> Obtains the value of the given field, or the default value if it is not set.getRepeatedField(Descriptors.FieldDescriptor field, int index) Gets an element of a repeated field.intGets the number of elements of a repeated field.final <T> booleanhasExtension(Extension<MessageT, T> extension) Check if a singular extension is present.final <T> booleanhasExtension(ExtensionLite<MessageT, T> extensionLite) Check if a singular extension is present.final <T> booleanhasExtension(GeneratedMessage.GeneratedExtension<MessageT, T> extension) Check if a singular extension is present.booleanReturns true if the given field is set.booleanReturns true if all required fields in the message and all embedded messages are set, false otherwise.protected voidUsed by parsing constructors in generated classes.protected booleanparseUnknownField(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) Called by subclasses to parse an unknown field.protected booleanparseUnknownFieldProto3(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) Delegates to parseUnknownField.private voidprivate voidverifyExtensionContainingType(Extension<MessageT, ?> extension) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getDescriptorForType, getFieldRaw, getOneofFieldDescriptor, getParserForType, getSerializedSize, getUnknownFields, hasOneof, internalGetFieldAccessorTable, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, setUnknownFields, writeReplace, writeString, writeStringNoTag, writeToMethods inherited from class com.google.protobuf.AbstractMessage
compareFields, equals, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder
getDefaultInstanceForTypeMethods inherited from interface com.google.protobuf.Message
newBuilderForType, toBuilderMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getDescriptorForType, getInitializationErrorString, getOneofFieldDescriptor, getUnknownFields, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
extensions
-
-
Constructor Details
-
ExtendableMessage
protected ExtendableMessage() -
ExtendableMessage
-
-
Method Details
-
verifyExtensionContainingType
-
hasExtension
Check if a singular extension is present.- Specified by:
hasExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtensionCount
Get the number of elements in a repeated extension.- Specified by:
getExtensionCountin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtension
Get the value of an extension.- Specified by:
getExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtension
Get one element of a repeated extension.- Specified by:
getExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
hasExtension
Check if a singular extension is present.TODO: handled by ExtensionLite version
- Specified by:
hasExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
hasExtension
Check if a singular extension is present.TODO: handled by ExtensionLite version
- Specified by:
hasExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtensionCount
Get the number of elements in a repeated extension.TODO: handled by ExtensionLite version
- Specified by:
getExtensionCountin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtensionCount
public final <T> int getExtensionCount(GeneratedMessage.GeneratedExtension<MessageT, List<T>> extension) Get the number of elements in a repeated extension.TODO: handled by ExtensionLite version
- Specified by:
getExtensionCountin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtension
Get the value of an extension.TODO: handled by ExtensionLite version
- Specified by:
getExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtension
Get the value of an extension.TODO: handled by ExtensionLite version
- Specified by:
getExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtension
Get one element of a repeated extension.TODO: handled by ExtensionLite version
- Specified by:
getExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
getExtension
public final <T> T getExtension(GeneratedMessage.GeneratedExtension<MessageT, List<T>> extension, int index) Get one element of a repeated extension.TODO: handled by ExtensionLite version
- Specified by:
getExtensionin interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>
-
extensionsAreInitialized
protected boolean extensionsAreInitialized()Called by subclasses to check if all extensions are initialized. -
isInitialized
public boolean isInitialized()Description copied from interface:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessageV3
-
parseUnknownField
protected boolean parseUnknownField(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) throws IOException Description copied from class:GeneratedMessageV3Called by subclasses to parse an unknown field.TODO remove this method
- Overrides:
parseUnknownFieldin classGeneratedMessageV3- Returns:
trueunless the tag is an end-group tag.- Throws:
IOException
-
parseUnknownFieldProto3
protected boolean parseUnknownFieldProto3(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) throws IOException Delegates to parseUnknownField. This method is obsolete, but we must retain it for compatibility with older generated code.TODO: remove mutating method from immutable type
- Overrides:
parseUnknownFieldProto3in classGeneratedMessageV3- Throws:
IOException
-
makeExtensionsImmutable
protected void makeExtensionsImmutable()Used by parsing constructors in generated classes.TODO: remove unused method (extensions should be immutable after build)
- Overrides:
makeExtensionsImmutablein classGeneratedMessageV3
-
newExtensionWriter
-
newMessageSetExtensionWriter
protected GeneratedMessageV3.ExtendableMessage<MessageT>.ExtensionWriter newMessageSetExtensionWriter() -
extensionsSerializedSize
protected int extensionsSerializedSize()Called by subclasses to compute the size of extensions. -
extensionsSerializedSizeAsMessageSet
protected int extensionsSerializedSizeAsMessageSet() -
getExtensionFields
-
getAllFields
Description copied from interface:MessageOrBuilderReturns 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 callingMessageOrBuilder.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:
getAllFieldsin interfaceMessageOrBuilder- Overrides:
getAllFieldsin classGeneratedMessageV3
-
getAllFieldsRaw
Description copied from class:GeneratedMessageV3Returns 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 callingGeneratedMessageV3.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.- Overrides:
getAllFieldsRawin classGeneratedMessageV3
-
hasField
Description copied from interface:MessageOrBuilderReturns true if the given field is set. This is exactly equivalent to calling the generated "has" accessor method corresponding to the field. The return value of hasField() is semantically meaningful only for fields where field.hasPresence() == true.- Specified by:
hasFieldin interfaceMessageOrBuilder- Overrides:
hasFieldin classGeneratedMessageV3
-
getField
Description copied from interface:MessageOrBuilderObtains 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:
getFieldin interfaceMessageOrBuilder- Overrides:
getFieldin classGeneratedMessageV3
-
getRepeatedFieldCount
Description copied from interface:MessageOrBuilderGets 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:
getRepeatedFieldCountin interfaceMessageOrBuilder- Overrides:
getRepeatedFieldCountin classGeneratedMessageV3
-
getRepeatedField
Description copied from interface:MessageOrBuilderGets 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:
getRepeatedFieldin interfaceMessageOrBuilder- Overrides:
getRepeatedFieldin classGeneratedMessageV3
-
verifyContainingType
-