Package com.google.protobuf
Class Descriptors.EnumDescriptor
java.lang.Object
com.google.protobuf.Descriptors.GenericDescriptor
com.google.protobuf.Descriptors.EnumDescriptor
- All Implemented Interfaces:
Internal.EnumLiteMap<Descriptors.EnumValueDescriptor>
- Enclosing class:
Descriptors
public static final class Descriptors.EnumDescriptor
extends Descriptors.GenericDescriptor
implements Internal.EnumLiteMap<Descriptors.EnumValueDescriptor>
Describes an enum type.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Descriptors.Descriptor
private final int
private final Descriptors.FileDescriptor
private final String
private final int
private final Descriptors.EnumValueDescriptor[]
private final Descriptors.EnumValueDescriptor[]
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
EnumDescriptor
(DescriptorProtos.EnumDescriptorProto proto, Descriptors.FileDescriptor file, Descriptors.Descriptor parent, int index) -
Method Summary
Modifier and TypeMethodDescriptionfindValueByName
(String name) Find an enum value by name.findValueByNumber
(int number) Find an enum value by number.findValueByNumberCreatingIfUnknown
(int number) Get the enum value for a number.If this is a nested type, get the outer descriptor, otherwise null.getFile()
Get theDescriptors.FileDescriptor
containing this descriptor.Get the type's fully-qualified name.int
getIndex()
Get the index of this descriptor within its parent.getName()
Get the type's unqualified name.Get theEnumOptions
, defined indescriptor.proto
.(package private) int
Get a list of defined values for this enum.private void
toProto()
Convert the descriptor to its protocol message representation.
-
Field Details
-
index
private final int index -
proto
-
fullName
-
file
-
containingType
-
values
-
valuesSortedByNumber
-
distinctNumbers
private final int distinctNumbers -
unknownValues
-
cleanupQueue
-
-
Constructor Details
-
EnumDescriptor
private EnumDescriptor(DescriptorProtos.EnumDescriptorProto proto, Descriptors.FileDescriptor file, Descriptors.Descriptor parent, int index) throws Descriptors.DescriptorValidationException
-
-
Method Details
-
getIndex
public int getIndex()Get the index of this descriptor within its parent.- See Also:
-
toProto
Convert the descriptor to its protocol message representation.- Specified by:
toProto
in classDescriptors.GenericDescriptor
-
getName
Get the type's unqualified name.- Specified by:
getName
in classDescriptors.GenericDescriptor
-
getFullName
Get the type's fully-qualified name.- Specified by:
getFullName
in classDescriptors.GenericDescriptor
- See Also:
-
getFile
Get theDescriptors.FileDescriptor
containing this descriptor.- Specified by:
getFile
in classDescriptors.GenericDescriptor
-
getContainingType
If this is a nested type, get the outer descriptor, otherwise null. -
getOptions
Get theEnumOptions
, defined indescriptor.proto
. -
getValues
Get a list of defined values for this enum. -
findValueByName
Find an enum value by name.- Parameters:
name
- The unqualified name of the value (e.g. "FOO").- Returns:
- the value's descriptor, or
null
if not found.
-
findValueByNumber
Find an enum value by number. If multiple enum values have the same number, this returns the first defined value with that number.- Specified by:
findValueByNumber
in interfaceInternal.EnumLiteMap<Descriptors.EnumValueDescriptor>
- Parameters:
number
- The value's number.- Returns:
- the value's descriptor, or
null
if not found.
-
findValueByNumberCreatingIfUnknown
Get the enum value for a number. If no enum value has this number, construct an EnumValueDescriptor for it. -
getUnknownEnumValueDescriptorCount
int getUnknownEnumValueDescriptorCount() -
setProto
-