Class DescriptorProtos.EnumDescriptorProto

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

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

PARSER

public static final Parser<DescriptorProtos.EnumDescriptorProto> PARSER
Field Value
TypeDescription
Parser<EnumDescriptorProto>

RESERVED_NAME_FIELD_NUMBER

public static final int RESERVED_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RESERVED_RANGE_FIELD_NUMBER

public static final int RESERVED_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DescriptorProtos.EnumDescriptorProto getDefaultInstance()
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptors.Descriptor

newBuilder()

public static DescriptorProtos.EnumDescriptorProto.Builder newBuilder()
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto.Builder

newBuilder(DescriptorProtos.EnumDescriptorProto prototype)

public static DescriptorProtos.EnumDescriptorProto.Builder newBuilder(DescriptorProtos.EnumDescriptorProto prototype)
Parameter
NameDescription
prototypeDescriptorProtos.EnumDescriptorProto
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto.Builder

parseDelimitedFrom(InputStream input)

public static DescriptorProtos.EnumDescriptorProto parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DescriptorProtos.EnumDescriptorProto parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DescriptorProtos.EnumDescriptorProto parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DescriptorProtos.EnumDescriptorProto parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DescriptorProtos.EnumDescriptorProto> parser()
Returns
TypeDescription
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
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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
TypeDescription
DescriptorProtos.EnumDescriptorProto

getName()

public String getName()

optional string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

optional string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOptions()

public DescriptorProtos.EnumOptions getOptions()

optional .google.protobuf.EnumOptions options = 3;

Returns
TypeDescription
DescriptorProtos.EnumOptions

The options.

getOptionsOrBuilder()

public DescriptorProtos.EnumOptionsOrBuilder getOptionsOrBuilder()

optional .google.protobuf.EnumOptions options = 3;

Returns
TypeDescription
DescriptorProtos.EnumOptionsOrBuilder

getParserForType()

public Parser<DescriptorProtos.EnumDescriptorProto> getParserForType()
Returns
TypeDescription
Parser<EnumDescriptorProto>
Overrides

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

Returns
TypeDescription
UnknownFieldSet
Overrides

getValue(int index)

public DescriptorProtos.EnumValueDescriptorProto getValue(int index)

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.EnumValueDescriptorProto

getValueCount()

public int getValueCount()

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Returns
TypeDescription
int

getValueList()

public List<DescriptorProtos.EnumValueDescriptorProto> getValueList()

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Returns
TypeDescription
List<EnumValueDescriptorProto>

getValueOrBuilder(int index)

public DescriptorProtos.EnumValueDescriptorProtoOrBuilder getValueOrBuilder(int index)

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.EnumValueDescriptorProtoOrBuilder

getValueOrBuilderList()

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

repeated .google.protobuf.EnumValueDescriptorProto value = 2;

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

hasName()

public boolean hasName()

optional string name = 1;

Returns
TypeDescription
boolean

Whether the name field is set.

hasOptions()

public boolean hasOptions()

optional .google.protobuf.EnumOptions options = 3;

Returns
TypeDescription
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
TypeDescription
int
Overrides

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
TypeDescription
GeneratedMessageV3.FieldAccessorTable
Overrides

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
TypeDescription
boolean
Overrides

newBuilderForType()

public DescriptorProtos.EnumDescriptorProto.Builder newBuilderForType()
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

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

Parameter
NameDescription
parentGeneratedMessageV3.BuilderParent
Returns
TypeDescription
DescriptorProtos.EnumDescriptorProto.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

Parameter
NameDescription
unusedGeneratedMessageV3.UnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DescriptorProtos.EnumDescriptorProto.Builder toBuilder()
Returns
TypeDescription
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
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException