Enum (lib 1.0.0 API)

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

All Implemented Interfaces:

EnumOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
```
public final class Enum
extends com.google.protobuf.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
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

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(java.lang.Object obj)`
`static Enum`	`getDefaultInstance()`
`Enum`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`EnumValue`	`getEnumvalue(int index)` Enum value definitions.
`int`	`getEnumvalueCount()` Enum value definitions.
`java.util.List<EnumValue>`	`getEnumvalueList()` Enum value definitions.
`EnumValueOrBuilder`	`getEnumvalueOrBuilder(int index)` Enum value definitions.
`java.util.List<? extends EnumValueOrBuilder>`	`getEnumvalueOrBuilderList()` Enum value definitions.
`java.lang.String`	`getName()` Enum type name.
`com.google.protobuf.ByteString`	`getNameBytes()` Enum type name.
`Option`	`getOptions(int index)` Protocol buffer options.
`int`	`getOptionsCount()` Protocol buffer options.
`java.util.List<Option>`	`getOptionsList()` Protocol buffer options.
`OptionOrBuilder`	`getOptionsOrBuilder(int index)` Protocol buffer options.
`java.util.List<? extends OptionOrBuilder>`	`getOptionsOrBuilderList()` Protocol buffer options.
`com.google.protobuf.Parser<Enum>`	`getParserForType()`
`int`	`getSerializedSize()`
`SourceContext`	`getSourceContext()` The source context.
`SourceContextOrBuilder`	`getSourceContextOrBuilder()` The source context.
`Syntax`	`getSyntax()` The source syntax.
`int`	`getSyntaxValue()` The source syntax.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasSourceContext()` The source context.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Enum.Builder`	`newBuilder()`
`static Enum.Builder`	`newBuilder(Enum prototype)`
`Enum.Builder`	`newBuilderForType()`
`protected Enum.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static Enum`	`parseDelimitedFrom(java.io.InputStream input)`
`static Enum`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(byte[] data)`
`static Enum`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(java.nio.ByteBuffer data)`
`static Enum`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(com.google.protobuf.ByteString data)`
`static Enum`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Enum`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Enum`	`parseFrom(java.io.InputStream input)`
`static Enum`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Enum>`	`parser()`
`Enum.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream 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, makeExtensionsImmutable, 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
  - getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
    Specified by:
    
    getUnknownFields in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
  - getName
```
public java.lang.String getName()
```
```
 Enum type name.
 
```
    string name = 1;
    Specified by:
    
    getName in interface EnumOrBuilder
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Enum type name.
 
```
    string name = 1;
    Specified by:
    
    getNameBytes in interface EnumOrBuilder
  - getEnumvalueList
```
public java.util.List<EnumValue> getEnumvalueList()
```
```
 Enum value definitions.
 
```
    repeated .google.protobuf.EnumValue enumvalue = 2;
    Specified by:
    
    getEnumvalueList in interface EnumOrBuilder
  - getEnumvalueOrBuilderList
```
public java.util.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 java.util.List<Option> getOptionsList()
```
```
 Protocol buffer options.
 
```
    repeated .google.protobuf.Option options = 3;
    Specified by:
    
    getOptionsList in interface EnumOrBuilder
  - getOptionsOrBuilderList
```
public java.util.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
  - getSourceContext
```
public SourceContext getSourceContext()
```
```
 The source context.
 
```
    .google.protobuf.SourceContext source_context = 4;
    Specified by:
    
    getSourceContext in interface EnumOrBuilder
  - 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
  - getSyntax
```
public Syntax getSyntax()
```
```
 The source syntax.
 
```
    .google.protobuf.Syntax syntax = 5;
    Specified by:
    
    getSyntax in interface EnumOrBuilder
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
```
    Specified by:
    
    writeTo in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    writeTo in class com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    java.io.IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Specified by:
    
    getSerializedSize in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getSerializedSize in class com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface com.google.protobuf.Message
    
    Overrides:
    
    equals in class com.google.protobuf.AbstractMessage
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface com.google.protobuf.Message
    
    Overrides:
    
    hashCode in class com.google.protobuf.AbstractMessage
  - parseFrom
```
public static Enum parseFrom(java.nio.ByteBuffer data)
                      throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(java.nio.ByteBuffer data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(com.google.protobuf.ByteString data)
                      throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(com.google.protobuf.ByteString data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(byte[] data)
                      throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(byte[] data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Enum parseFrom(java.io.InputStream input)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Enum parseFrom(java.io.InputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static Enum parseDelimitedFrom(java.io.InputStream input)
                               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static Enum parseDelimitedFrom(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Enum parseFrom(com.google.protobuf.CodedInputStream input)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Enum parseFrom(com.google.protobuf.CodedInputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - newBuilderForType
```
public Enum.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static Enum.Builder newBuilder()
```
  - newBuilder
```
public static Enum.Builder newBuilder(Enum prototype)
```
  - toBuilder
```
public Enum.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected Enum.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static Enum getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<Enum> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<Enum> getParserForType()
```
    Specified by:
    
    getParserForType in interface com.google.protobuf.Message
    
    Specified by:
    
    getParserForType in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getParserForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstanceForType
```
public Enum getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class Enum

Nested Class Summary

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

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

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