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.Descriptorprivate final intprivate final Descriptors.FileDescriptorprivate final Stringprivate final intprivate final Descriptors.EnumValueDescriptor[]private final Descriptors.EnumValueDescriptor[] -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateEnumDescriptor(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.FileDescriptorcontaining this descriptor.Get the type's fully-qualified name.intgetIndex()Get the index of this descriptor within its parent.getName()Get the type's unqualified name.Get theEnumOptions, defined indescriptor.proto.(package private) intGet a list of defined values for this enum.booleanisClosed()Determines if the given enum is closed.booleanisReservedName(String name) Determines if the given field name is reserved.booleanisReservedNumber(int number) Determines if the given field number is reserved.private voidtoProto()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:
toProtoin classDescriptors.GenericDescriptor
-
getName
Get the type's unqualified name.- Specified by:
getNamein classDescriptors.GenericDescriptor
-
getFullName
Get the type's fully-qualified name.- Specified by:
getFullNamein classDescriptors.GenericDescriptor- See Also:
-
getFile
Get theDescriptors.FileDescriptorcontaining this descriptor.- Specified by:
getFilein classDescriptors.GenericDescriptor
-
isClosed
public boolean isClosed()Determines if the given enum is closed.Closed enum means that it:
- Has a fixed set of values, rather than being equivalent to an int32.
- Encountering values not in this set causes them to be treated as unknown fields.
- The first value (i.e., the default) may be nonzero.
WARNING: Some runtimes currently have a quirk where non-closed enums are treated as closed when used as the type of fields defined in a `syntax = proto2;` file. This quirk is not present in all runtimes; as of writing, we know that:
- C++, Java, and C++-based Python share this quirk.
- UPB and UPB-based Python do not.
- PHP and Ruby treat all enums as open regardless of declaration.
Care should be taken when using this function to respect the target runtime's enum handling quirks.
-
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. -
isReservedNumber
public boolean isReservedNumber(int number) Determines if the given field number is reserved. -
isReservedName
Determines if the given field name is reserved. -
findValueByName
Find an enum value by name.- Parameters:
name- the unqualified name of the value such as "FOO"- Returns:
- the value's descriptor, or
nullif 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:
findValueByNumberin interfaceInternal.EnumLiteMap<Descriptors.EnumValueDescriptor>- Parameters:
number- The value's number.- Returns:
- the value's descriptor, or
nullif 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
-