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 Classes

Modifier and Type	Class	Description
private static class	Descriptors.EnumDescriptor.UnknownEnumValueReference

Field Summary

Fields

Modifier and Type	Field	Description
private ReferenceQueue<Descriptors.EnumValueDescriptor>	cleanupQueue
private final int	distinctNumbers
private final String	fullName
private final int	index
private DescriptorProtos.EnumOptions	options
private final Descriptors.GenericDescriptor	parent
private final boolean	placeholder
private DescriptorProtos.EnumDescriptorProto	proto
private Map<Integer, WeakReference<Descriptors.EnumValueDescriptor>>	unknownValues
private final Descriptors.EnumValueDescriptor[]	values
private final Descriptors.EnumValueDescriptor[]	valuesSortedByNumber

Fields inherited from class Descriptors.GenericDescriptor

features

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EnumDescriptor(DescriptorProtos.EnumDescriptorProto proto, Descriptors.FileDescriptor file, Descriptors.Descriptor parent, int index)
private	EnumDescriptor(String fullName)

Method Summary

Modifier and Type	Method	Description
Descriptors.EnumValueDescriptor	findValueByName(String name)	Find an enum value by name.
Descriptors.EnumValueDescriptor	findValueByNumber(int number)	Find an enum value by number.
Descriptors.EnumValueDescriptor	findValueByNumberCreatingIfUnknown(int number)	Get the enum value for a number.
Descriptors.Descriptor	getContainingType()	If this is a nested type, get the outer descriptor, otherwise null.
Descriptors.FileDescriptor	getFile()	Get the Descriptors.FileDescriptor containing this descriptor.
String	getFullName()	Get the type's fully-qualified name.
int	getIndex()	Get the index of this descriptor within its parent.
String	getName()	Get the type's unqualified name.
DescriptorProtos.EnumOptions	getOptions()	Get the EnumOptions, defined in descriptor.proto.
(package private) Descriptors.GenericDescriptor	getParent()
(package private) int	getUnknownEnumValueDescriptorCount()
Descriptors.EnumValueDescriptor	getValue(int index)
int	getValueCount()
List<Descriptors.EnumValueDescriptor>	getValues()	Get a list of defined values for this enum.
boolean	isClosed()	Determines if the given enum is closed.
boolean	isPlaceholder()
boolean	isReservedName(String name)	Determines if the given field name is reserved.
boolean	isReservedNumber(int number)	Determines if the given field number is reserved.
private void	resolveAllFeatures()	See invalid reference FileDescriptor#resolveAllFeatures .
private void	setProto(DescriptorProtos.EnumDescriptorProto proto)	See Descriptors.FileDescriptor.setProto(DescriptorProtos.FileDescriptorProto).
DescriptorProtos.EnumDescriptorProto	toProto()	Convert the descriptor to its protocol message representation.

Methods inherited from class Descriptors.GenericDescriptor

getFeatures, inferLegacyProtoFeatures, resolveFeatures, validateFeatures

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

index

private final int index

proto

private DescriptorProtos.EnumDescriptorProto proto

options

private volatile DescriptorProtos.EnumOptions options

fullName

private final String fullName

parent

private final Descriptors.GenericDescriptor parent

values

private final Descriptors.EnumValueDescriptor[] values

valuesSortedByNumber

private final Descriptors.EnumValueDescriptor[] valuesSortedByNumber

distinctNumbers

private final int distinctNumbers

unknownValues

private Map<Integer, WeakReference<Descriptors.EnumValueDescriptor>> unknownValues

cleanupQueue

private ReferenceQueue<Descriptors.EnumValueDescriptor> cleanupQueue

placeholder

private final boolean placeholder

Constructor Details

EnumDescriptor

private EnumDescriptor(String fullName)
                throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

EnumDescriptor

private EnumDescriptor(DescriptorProtos.EnumDescriptorProto proto,
 Descriptors.FileDescriptor file,
 Descriptors.Descriptor parent,
 int index)
                throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

Method Details

getIndex

public int getIndex()

Get the index of this descriptor within its parent.

See Also:

• Descriptors.Descriptor.getIndex()

toProto

public DescriptorProtos.EnumDescriptorProto toProto()

Convert the descriptor to its protocol message representation.

Specified by:

toProto in class Descriptors.GenericDescriptor

getName

public String getName()

Get the type's unqualified name.

Specified by:

getName in class Descriptors.GenericDescriptor

getFullName

public String getFullName()

Get the type's fully-qualified name.

Specified by:

getFullName in class Descriptors.GenericDescriptor

See Also:

• Descriptors.Descriptor.getFullName()

getFile

public Descriptors.FileDescriptor getFile()

Get the Descriptors.FileDescriptor containing this descriptor.

Specified by:

getFile in class Descriptors.GenericDescriptor

getParent

Descriptors.GenericDescriptor getParent()

Specified by:

getParent in class Descriptors.GenericDescriptor

isPlaceholder

public boolean isPlaceholder()

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

public Descriptors.Descriptor getContainingType()

If this is a nested type, get the outer descriptor, otherwise null.

getOptions

public DescriptorProtos.EnumOptions getOptions()

Get the EnumOptions, defined in descriptor.proto.

getValues

public List<Descriptors.EnumValueDescriptor> getValues()

Get a list of defined values for this enum.

getValueCount

public int getValueCount()

getValue

public Descriptors.EnumValueDescriptor getValue(int index)

isReservedNumber

public boolean isReservedNumber(int number)

Determines if the given field number is reserved.

isReservedName

public boolean isReservedName(String name)

Determines if the given field name is reserved.

findValueByName

public Descriptors.EnumValueDescriptor findValueByName(String name)

Find an enum value by name.

Parameters:

name - the unqualified name of the value such as "FOO"

Returns:

the value's descriptor, or null if not found

findValueByNumber

public Descriptors.EnumValueDescriptor findValueByNumber(int number)

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 interface Internal.EnumLiteMap<Descriptors.EnumValueDescriptor>

Parameters:

number - The value's number.

Returns:

the value's descriptor, or null if not found.

findValueByNumberCreatingIfUnknown

public Descriptors.EnumValueDescriptor findValueByNumberCreatingIfUnknown(int number)

Get the enum value for a number. If no enum value has this number, construct an EnumValueDescriptor for it.

getUnknownEnumValueDescriptorCount

int getUnknownEnumValueDescriptorCount()

resolveAllFeatures

private void resolveAllFeatures()
                         throws Descriptors.DescriptorValidationException

See

invalid reference

FileDescriptor#resolveAllFeatures

.

Throws:

Descriptors.DescriptorValidationException

setProto

private void setProto(DescriptorProtos.EnumDescriptorProto proto)
               throws Descriptors.DescriptorValidationException

See Descriptors.FileDescriptor.setProto(DescriptorProtos.FileDescriptorProto).

Throws:

Descriptors.DescriptorValidationException