public static final class DescriptorProtos.EnumDescriptorProto extends GeneratedMessageV3 implements DescriptorProtos.EnumDescriptorProtoOrBuilder
Describes an enum type.
Protobuf type google.protobuf.EnumDescriptorProto
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
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DescriptorProtos.EnumDescriptorProto.Builder newBuilder()
newBuilder(DescriptorProtos.EnumDescriptorProto prototype)
public static DescriptorProtos.EnumDescriptorProto.Builder newBuilder(DescriptorProtos.EnumDescriptorProto prototype)
public static DescriptorProtos.EnumDescriptorProto parseDelimitedFrom(InputStream input)
public static DescriptorProtos.EnumDescriptorProto parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DescriptorProtos.EnumDescriptorProto parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.EnumDescriptorProto parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.EnumDescriptorProto parseFrom(CodedInputStream input)
public static DescriptorProtos.EnumDescriptorProto parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.EnumDescriptorProto parseFrom(InputStream input)
public static DescriptorProtos.EnumDescriptorProto parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.EnumDescriptorProto parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DescriptorProtos.EnumDescriptorProto> parser()
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
|
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.
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;
getOptionsOrBuilder()
public DescriptorProtos.EnumOptionsOrBuilder getOptionsOrBuilder()
optional .google.protobuf.EnumOptions options = 3;
getParserForType()
public Parser<DescriptorProtos.EnumDescriptorProto> getParserForType()
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 |
| 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;
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
|
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;
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
|
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getValue(int index)
public DescriptorProtos.EnumValueDescriptorProto getValue(int index)
repeated .google.protobuf.EnumValueDescriptorProto value = 2;
| Parameter |
| Name |
Description |
index |
int
|
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;
getValueOrBuilder(int index)
public DescriptorProtos.EnumValueDescriptorProtoOrBuilder getValueOrBuilder(int index)
repeated .google.protobuf.EnumValueDescriptorProto value = 2;
| Parameter |
| Name |
Description |
index |
int
|
getValueOrBuilderList()
public List<? extends DescriptorProtos.EnumValueDescriptorProtoOrBuilder> getValueOrBuilderList()
repeated .google.protobuf.EnumValueDescriptorProto value = 2;
| Returns |
| Type |
Description |
List<? extends com.google.protobuf.DescriptorProtos.EnumValueDescriptorProtoOrBuilder> |
|
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()
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
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.
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DescriptorProtos.EnumDescriptorProto.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DescriptorProtos.EnumDescriptorProto.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Creates a new instance of this message type. Overridden in the generated code.
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public DescriptorProtos.EnumDescriptorProto.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Serializes the message and writes it to output. This does not flush or close the
stream.
