Class DescriptorProtos.EnumDescriptorProto (3.19.4)

public static final class DescriptorProtos.EnumDescriptorProto extends GeneratedMessageV3 implements DescriptorProtos.EnumDescriptorProtoOrBuilder

Describes an enum type.

Protobuf type google.protobuf.EnumDescriptorProto

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DescriptorProtos.EnumDescriptorProto

Implements

DescriptorProtos.EnumDescriptorProtoOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

Field Value
Type	Description
int

PARSER

public static final Parser<DescriptorProtos.EnumDescriptorProto> PARSER

Field Value
Type	Description
Parser<EnumDescriptorProto>

RESERVED_NAME_FIELD_NUMBER

public static final int RESERVED_NAME_FIELD_NUMBER

Field Value
Type	Description
int

RESERVED_RANGE_FIELD_NUMBER

public static final int RESERVED_RANGE_FIELD_NUMBER

Field Value
Type	Description
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DescriptorProtos.EnumDescriptorProto getDefaultInstance()

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptors.Descriptor

newBuilder()

public static DescriptorProtos.EnumDescriptorProto.Builder newBuilder()

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto.Builder

newBuilder(DescriptorProtos.EnumDescriptorProto prototype)

public static DescriptorProtos.EnumDescriptorProto.Builder newBuilder(DescriptorProtos.EnumDescriptorProto prototype)

Parameter
Name	Description
prototype	DescriptorProtos.EnumDescriptorProto

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto.Builder

parseDelimitedFrom(InputStream input)

public static DescriptorProtos.EnumDescriptorProto parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DescriptorProtos.EnumDescriptorProto parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DescriptorProtos.EnumDescriptorProto parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DescriptorProtos.EnumDescriptorProto parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DescriptorProtos.EnumDescriptorProto> parser()

Returns
Type	Description
Parser<EnumDescriptorProto>

Methods

equals(Object obj)

public boolean equals(Object obj)

Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public DescriptorProtos.EnumDescriptorProto getDefaultInstanceForType()

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto

getName()

public String getName()

optional string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

optional string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getOptions()

public DescriptorProtos.EnumOptions getOptions()

optional .google.protobuf.EnumOptions options = 3;

Returns
Type	Description
DescriptorProtos.EnumOptions	The options.

getOptionsOrBuilder()

public DescriptorProtos.EnumOptionsOrBuilder getOptionsOrBuilder()

optional .google.protobuf.EnumOptions options = 3;

Returns
Type	Description
DescriptorProtos.EnumOptionsOrBuilder

getParserForType()

public Parser<DescriptorProtos.EnumDescriptorProto> getParserForType()

Returns
Type	Description
Parser<EnumDescriptorProto>

Overrides

GeneratedMessageV3.getParserForType()

getReservedName(int index)

public String getReservedName(int index)

Reserved enum value names, which may not be reused. A given name may only be reserved once.

repeated string reserved_name = 5;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The reservedName at the given index.

getReservedNameBytes(int index)

public ByteString getReservedNameBytes(int index)

Reserved enum value names, which may not be reused. A given name may only be reserved once.

repeated string reserved_name = 5;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the reservedName at the given index.

getReservedNameCount()

public int getReservedNameCount()

Reserved enum value names, which may not be reused. A given name may only be reserved once.

repeated string reserved_name = 5;

Returns
Type	Description
int	The count of reservedName.

getReservedNameList()

public ProtocolStringList getReservedNameList()

Reserved enum value names, which may not be reused. A given name may only be reserved once.

repeated string reserved_name = 5;

Returns
Type	Description
ProtocolStringList	A list containing the reservedName.

getReservedRange(int index)

public DescriptorProtos.EnumDescriptorProto.EnumReservedRange getReservedRange(int index)

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto.EnumReservedRange

getReservedRangeCount()

public int getReservedRangeCount()

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;

Returns
Type	Description
int

getReservedRangeList()

public List<DescriptorProtos.EnumDescriptorProto.EnumReservedRange> getReservedRangeList()

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;

Returns
Type	Description
List<EnumReservedRange>

getReservedRangeOrBuilder(int index)

public DescriptorProtos.EnumDescriptorProto.EnumReservedRangeOrBuilder getReservedRangeOrBuilder(int index)

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto.EnumReservedRangeOrBuilder

getReservedRangeOrBuilderList()

public List<? extends DescriptorProtos.EnumDescriptorProto.EnumReservedRangeOrBuilder> getReservedRangeOrBuilderList()

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

repeated .google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;

Returns
Type	Description
List<? extends com.google.protobuf.DescriptorProtos.EnumDescriptorProto.EnumReservedRangeOrBuilder>

getSerializedSize()

public int getSerializedSize()

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getValue(int index)

public DescriptorProtos.EnumValueDescriptorProto getValue(int index)

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.EnumValueDescriptorProto

getValueCount()

public int getValueCount()

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Returns
Type	Description
int

getValueList()

public List<DescriptorProtos.EnumValueDescriptorProto> getValueList()

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Returns
Type	Description
List<EnumValueDescriptorProto>

getValueOrBuilder(int index)

public DescriptorProtos.EnumValueDescriptorProtoOrBuilder getValueOrBuilder(int index)

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.EnumValueDescriptorProtoOrBuilder

getValueOrBuilderList()

public List<? extends DescriptorProtos.EnumValueDescriptorProtoOrBuilder> getValueOrBuilderList()

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Returns
Type	Description
List<? extends com.google.protobuf.DescriptorProtos.EnumValueDescriptorProtoOrBuilder>

hasName()

public boolean hasName()

optional string name = 1;

Returns
Type	Description
boolean	Whether the name field is set.

hasOptions()

public boolean hasOptions()

optional .google.protobuf.EnumOptions options = 3;

Returns
Type	Description
boolean	Whether the options field is set.

hashCode()

public int hashCode()

Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Returns
Type	Description
GeneratedMessageV3.FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder#getInitializationErrorString()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public DescriptorProtos.EnumDescriptorProto.Builder newBuilderForType()

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DescriptorProtos.EnumDescriptorProto.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.

Parameter
Name	Description
parent	GeneratedMessageV3.BuilderParent

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Creates a new instance of this message type. Overridden in the generated code.

Parameter
Name	Description
unused	GeneratedMessageV3.UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public DescriptorProtos.EnumDescriptorProto.Builder toBuilder()

Returns
Type	Description
DescriptorProtos.EnumDescriptorProto.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Serializes the message and writes it to output. This does not flush or close the stream.

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException