Enum (Protocol Buffers [Core] 3.21.7 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.protobuf.Enum

All Implemented Interfaces:

EnumOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable
```
public final class Enum
extends GeneratedMessageV3
implements EnumOrBuilder
```
```
 Enum type definition.
 
```
Protobuf type google.protobuf.Enum
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Enum.Builder
Enum type definition.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`Enum.Builder` Enum type definition.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ENUMVALUE_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`OPTIONS_FIELD_NUMBER`
`static int`	`SOURCE_CONTEXT_FIELD_NUMBER`
`static int`	`SYNTAX_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Compares the specified object with this message for equality.
`static Enum`	`getDefaultInstance()`
`Enum`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`EnumValue`	`getEnumvalue(int index)` Enum value definitions.
`int`	`getEnumvalueCount()` Enum value definitions.
`List<EnumValue>`	`getEnumvalueList()` Enum value definitions.
`EnumValueOrBuilder`	`getEnumvalueOrBuilder(int index)` Enum value definitions.
`List<? extends EnumValueOrBuilder>`	`getEnumvalueOrBuilderList()` Enum value definitions.
`String`	`getName()` Enum type name.
`ByteString`	`getNameBytes()` Enum type name.
`Option`	`getOptions(int index)` Protocol buffer options.
`int`	`getOptionsCount()` Protocol buffer options.
`List<Option>`	`getOptionsList()` Protocol buffer options.
`OptionOrBuilder`	`getOptionsOrBuilder(int index)` Protocol buffer options.
`List<? extends OptionOrBuilder>`	`getOptionsOrBuilderList()` Protocol buffer options.
`Parser<Enum>`	`getParserForType()` Gets the parser for a message of the same type as this message.
`int`	`getSerializedSize()` Get the number of bytes required to encode this message.
`SourceContext`	`getSourceContext()` The source context.
`SourceContextOrBuilder`	`getSourceContextOrBuilder()` The source context.
`Syntax`	`getSyntax()` The source syntax.
`int`	`getSyntaxValue()` The source syntax.
`UnknownFieldSet`	`getUnknownFields()` Get the `UnknownFieldSet` for this message.
`int`	`hashCode()` Returns the hash code value for this message.
`boolean`	`hasSourceContext()` The source context.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()` Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`static Enum.Builder`	`newBuilder()`
`static Enum.Builder`	`newBuilder(Enum prototype)`
`Enum.Builder`	`newBuilderForType()` Constructs a new builder for a message of the same type as this message.
`protected Enum.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)` TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)` Creates a new instance of this message type.
`static Enum`	`parseDelimitedFrom(InputStream input)`
`static Enum`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(byte[] data)`
`static Enum`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(ByteBuffer data)`
`static Enum`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(ByteString data)`
`static Enum`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(CodedInputStream input)`
`static Enum`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(InputStream input)`
`static Enum`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<Enum>`	`parser()`
`Enum.Builder`	`toBuilder()` Constructs a builder initialized with the current message.
`void`	`writeTo(CodedOutputStream output)` Serializes the message and writes it to `output`.

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - ENUMVALUE_FIELD_NUMBER
```
public static final int ENUMVALUE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - OPTIONS_FIELD_NUMBER
```
public static final int OPTIONS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - SOURCE_CONTEXT_FIELD_NUMBER
```
public static final int SOURCE_CONTEXT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - SYNTAX_FIELD_NUMBER
```
public static final int SYNTAX_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - newInstance
```
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
```
    Description copied from class: GeneratedMessageV3
    
    Creates a new instance of this message type. Overridden in the generated code.
    
    Overrides:
    
    newInstance in class GeneratedMessageV3
  - getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
    Description copied from interface: MessageOrBuilder
    
    Get the UnknownFieldSet for this message.
    
    Specified by:
    
    getUnknownFields in interface MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class GeneratedMessageV3
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessageV3
    
    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.
    
    Specified by:
    
    internalGetFieldAccessorTable in class GeneratedMessageV3
  - getName
```
public String getName()
```
```
 Enum type name.
 
```
    string name = 1;
    Specified by:
    
    getName in interface EnumOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public ByteString getNameBytes()
```
```
 Enum type name.
 
```
    string name = 1;
    Specified by:
    
    getNameBytes in interface EnumOrBuilder
    
    Returns:
    
    The bytes for name.
  - getEnumvalueList
```
public List<EnumValue> getEnumvalueList()
```
```
 Enum value definitions.
 
```
    repeated .google.protobuf.EnumValue enumvalue = 2;
    Specified by:
    
    getEnumvalueList in interface EnumOrBuilder
  - getEnumvalueOrBuilderList
```
public List<? extends EnumValueOrBuilder> getEnumvalueOrBuilderList()
```
```
 Enum value definitions.
 
```
    repeated .google.protobuf.EnumValue enumvalue = 2;
    Specified by:
    
    getEnumvalueOrBuilderList in interface EnumOrBuilder
  - getEnumvalueCount
```
public int getEnumvalueCount()
```
```
 Enum value definitions.
 
```
    repeated .google.protobuf.EnumValue enumvalue = 2;
    Specified by:
    
    getEnumvalueCount in interface EnumOrBuilder
  - getEnumvalue
```
public EnumValue getEnumvalue(int index)
```
```
 Enum value definitions.
 
```
    repeated .google.protobuf.EnumValue enumvalue = 2;
    Specified by:
    
    getEnumvalue in interface EnumOrBuilder
  - getEnumvalueOrBuilder
```
public EnumValueOrBuilder getEnumvalueOrBuilder(int index)
```
```
 Enum value definitions.
 
```
    repeated .google.protobuf.EnumValue enumvalue = 2;
    Specified by:
    
    getEnumvalueOrBuilder in interface EnumOrBuilder
  - getOptionsList
```
public List<Option> getOptionsList()
```
```
 Protocol buffer options.
 
```
    repeated .google.protobuf.Option options = 3;
    Specified by:
    
    getOptionsList in interface EnumOrBuilder
  - getOptionsOrBuilderList
```
public List<? extends OptionOrBuilder> getOptionsOrBuilderList()
```
```
 Protocol buffer options.
 
```
    repeated .google.protobuf.Option options = 3;
    Specified by:
    
    getOptionsOrBuilderList in interface EnumOrBuilder
  - getOptionsCount
```
public int getOptionsCount()
```
```
 Protocol buffer options.
 
```
    repeated .google.protobuf.Option options = 3;
    Specified by:
    
    getOptionsCount in interface EnumOrBuilder
  - getOptions
```
public Option getOptions(int index)
```
```
 Protocol buffer options.
 
```
    repeated .google.protobuf.Option options = 3;
    Specified by:
    
    getOptions in interface EnumOrBuilder
  - getOptionsOrBuilder
```
public OptionOrBuilder getOptionsOrBuilder(int index)
```
```
 Protocol buffer options.
 
```
    repeated .google.protobuf.Option options = 3;
    Specified by:
    
    getOptionsOrBuilder in interface EnumOrBuilder
  - hasSourceContext
```
public boolean hasSourceContext()
```
```
 The source context.
 
```
    .google.protobuf.SourceContext source_context = 4;
    Specified by:
    
    hasSourceContext in interface EnumOrBuilder
    
    Returns:
    
    Whether the sourceContext field is set.
  - getSourceContext
```
public SourceContext getSourceContext()
```
```
 The source context.
 
```
    .google.protobuf.SourceContext source_context = 4;
    Specified by:
    
    getSourceContext in interface EnumOrBuilder
    
    Returns:
    
    The sourceContext.
  - getSourceContextOrBuilder
```
public SourceContextOrBuilder getSourceContextOrBuilder()
```
```
 The source context.
 
```
    .google.protobuf.SourceContext source_context = 4;
    Specified by:
    
    getSourceContextOrBuilder in interface EnumOrBuilder
  - getSyntaxValue
```
public int getSyntaxValue()
```
```
 The source syntax.
 
```
    .google.protobuf.Syntax syntax = 5;
    Specified by:
    
    getSyntaxValue in interface EnumOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for syntax.
  - getSyntax
```
public Syntax getSyntax()
```
```
 The source syntax.
 
```
    .google.protobuf.Syntax syntax = 5;
    Specified by:
    
    getSyntax in interface EnumOrBuilder
    
    Returns:
    
    The syntax.
  - isInitialized
```
public final boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessageV3
  - writeTo
```
public void writeTo(CodedOutputStream output)
             throws IOException
```
    Description copied from interface: MessageLite
    
    Serializes the message and writes it to output. This does not flush or close the stream.
    
    Specified by:
    
    writeTo in interface MessageLite
    
    Overrides:
    
    writeTo in class GeneratedMessageV3
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Description copied from interface: MessageLite
    
    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.
    
    Specified by:
    
    getSerializedSize in interface MessageLite
    
    Overrides:
    
    getSerializedSize in class GeneratedMessageV3
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: Message
    
    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.
    
    Specified by:
    
    equals in interface Message
    
    Overrides:
    
    equals in class AbstractMessage
    
    Parameters:
    
    obj - object to be compared for equality with this message
    
    Returns:
    
    true if the specified object is equal to this message
  - hashCode
```
public int hashCode()
```
    Description copied from interface: Message
    
    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.
    
    Specified by:
    
    hashCode in interface Message
    
    Overrides:
    
    hashCode in class AbstractMessage
    
    Returns:
    
    the hash code value for this message
    
    See Also:
    
    Map.hashCode()
  - parseFrom
```
public static Enum parseFrom(ByteBuffer data)
                      throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(ByteBuffer data,
                             ExtensionRegistryLite extensionRegistry)
                      throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(ByteString data)
                      throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(ByteString data,
                             ExtensionRegistryLite extensionRegistry)
                      throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(byte[] data)
                      throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(byte[] data,
                             ExtensionRegistryLite extensionRegistry)
                      throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(InputStream input)
                      throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Enum parseFrom(InputStream input,
                             ExtensionRegistryLite extensionRegistry)
                      throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Enum parseDelimitedFrom(InputStream input)
                               throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Enum parseDelimitedFrom(InputStream input,
                                      ExtensionRegistryLite extensionRegistry)
                               throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Enum parseFrom(CodedInputStream input)
                      throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Enum parseFrom(CodedInputStream input,
                             ExtensionRegistryLite extensionRegistry)
                      throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public Enum.Builder newBuilderForType()
```
    Description copied from interface: MessageLite
    
    Constructs a new builder for a message of the same type as this message.
    
    Specified by:
    
    newBuilderForType in interface Message
    
    Specified by:
    
    newBuilderForType in interface MessageLite
  - newBuilder
```
public static Enum.Builder newBuilder()
```
  - newBuilder
```
public static Enum.Builder newBuilder(Enum prototype)
```
  - toBuilder
```
public Enum.Builder toBuilder()
```
    Description copied from interface: MessageLite
    
    Constructs a builder initialized with the current message. Use this to derive a new message from the current one.
    
    Specified by:
    
    toBuilder in interface Message
    
    Specified by:
    
    toBuilder in interface MessageLite
  - newBuilderForType
```
protected Enum.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
```
    Description copied from class: GeneratedMessageV3
    
    TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
    
    Specified by:
    
    newBuilderForType in class GeneratedMessageV3
  - getDefaultInstance
```
public static Enum getDefaultInstance()
```
  - parser
```
public static Parser<Enum> parser()
```
  - getParserForType
```
public Parser<Enum> getParserForType()
```
    Description copied from interface: MessageLite
    
    Gets the parser for a message of the same type as this message.
    
    Specified by:
    
    getParserForType in interface Message
    
    Specified by:
    
    getParserForType in interface MessageLite
    
    Overrides:
    
    getParserForType in class GeneratedMessageV3
  - getDefaultInstanceForType
```
public Enum getDefaultInstanceForType()
```
    Description copied from interface: MessageLiteOrBuilder
    
    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.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder

Class Enum

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

NAME_FIELD_NUMBER

ENUMVALUE_FIELD_NUMBER

OPTIONS_FIELD_NUMBER

SOURCE_CONTEXT_FIELD_NUMBER

SYNTAX_FIELD_NUMBER

Method Detail

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getName

getNameBytes

getEnumvalueList

getEnumvalueOrBuilderList

getEnumvalueCount

getEnumvalue

getEnumvalueOrBuilder

getOptionsList

getOptionsOrBuilderList

getOptionsCount

getOptions

getOptionsOrBuilder

hasSourceContext

getSourceContext

getSourceContextOrBuilder

getSyntaxValue

getSyntax

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType