Class Enum

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.protobuf.Enum

All Implemented Interfaces:

EnumOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

@Generated
public final class Enum
extends GeneratedMessage
implements EnumOrBuilder

Enum type definition.

New usages of this message as an alternative to EnumDescriptorProto are
strongly discouraged. This message does not reliability preserve all
information necessary to model the schema and preserve semantics. Instead
make use of FileDescriptorSet which preserves the necessary information.

Protobuf type google.protobuf.Enum

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Enum.Builder	Enum type definition.

Nested classes/interfaces inherited from class GeneratedMessage

GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, GeneratedMessage.ExtendableMessage<MessageT>, GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, GeneratedMessage.ExtensionDescriptorRetriever, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingT, T>, GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessage

AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
private int	bitField0_
private static final Enum	DEFAULT_INSTANCE
private Object	edition_
static final int	EDITION_FIELD_NUMBER
private List<EnumValue>	enumvalue_
static final int	ENUMVALUE_FIELD_NUMBER
private byte	memoizedIsInitialized
private Object	name_
static final int	NAME_FIELD_NUMBER
private List<Option>	options_
static final int	OPTIONS_FIELD_NUMBER
private static final Parser<Enum>	PARSER
private static final long	serialVersionUID
static final int	SOURCE_CONTEXT_FIELD_NUMBER
private SourceContext	sourceContext_
private int	syntax_
static final int	SYNTAX_FIELD_NUMBER

Fields inherited from class GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, PRE22_GENCODE_ERROR_PROPERTY, PRE22_GENCODE_SILENCE_PROPERTY, PRE22_GENCODE_VULNERABILITY_MESSAGE, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Enum()
private	Enum(GeneratedMessage.Builder<?> builder)

Method Summary

Modifier and Type	Method	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 final Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()	Get the message's type's descriptor.
String	getEdition()	The source edition string, only valid when syntax is SYNTAX_EDITIONS.
ByteString	getEditionBytes()	The source edition string, only valid when syntax is SYNTAX_EDITIONS.
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()	TODO: Remove this unnecessary intermediate implementation of this method.
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.
int	hashCode()	Returns the hash code value for this message.
boolean	hasSourceContext()	The source context.
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
final 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(AbstractMessage.BuilderParent parent)	Create a nested builder.
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(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 Enum	parseFrom(ByteBuffer data)
static Enum	parseFrom(ByteBuffer data, 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 GeneratedMessage

computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getField, getFieldRaw, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, setUnknownFields, warnPre22Gencode, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashFields, newUninitializedMessageException, setMemoizedSerializedSize, toString

Methods inherited from class AbstractMessageLite

addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

bitField0_

private int bitField0_

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

• Constant Field Values

name_

private volatile Object name_

ENUMVALUE_FIELD_NUMBER

public static final int ENUMVALUE_FIELD_NUMBER

See Also:

• Constant Field Values

enumvalue_

private List<EnumValue> enumvalue_

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

options_

private List<Option> options_

SOURCE_CONTEXT_FIELD_NUMBER

public static final int SOURCE_CONTEXT_FIELD_NUMBER

See Also:

• Constant Field Values

sourceContext_

private SourceContext sourceContext_

SYNTAX_FIELD_NUMBER

public static final int SYNTAX_FIELD_NUMBER

See Also:

• Constant Field Values

syntax_

private int syntax_

EDITION_FIELD_NUMBER

public static final int EDITION_FIELD_NUMBER

See Also:

• Constant Field Values

edition_

private volatile Object edition_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final Enum DEFAULT_INSTANCE

PARSER

private static final Parser<Enum> PARSER

Constructor Details

Enum

private Enum(GeneratedMessage.Builder<?> builder)

Enum

private Enum()

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: MessageOrBuilder

Get the message's type's descriptor. This differs from the getDescriptor() method of generated message classes in that this method is an abstract method of the Message interface whereas getDescriptor() is a static method of a specific class. They return the same thing.

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessage

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 GeneratedMessage

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.

getEdition

public String getEdition()

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

string edition = 6;

Specified by:

getEdition in interface EnumOrBuilder

Returns:

The edition.

getEditionBytes

public ByteString getEditionBytes()

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

string edition = 6;

Specified by:

getEditionBytes in interface EnumOrBuilder

Returns:

The bytes for edition.

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 GeneratedMessage

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 GeneratedMessage

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 GeneratedMessage

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(AbstractMessage.BuilderParent parent)

Description copied from class: AbstractMessage

Create a nested builder.

Overrides:

newBuilderForType in class AbstractMessage

getDefaultInstance

public static Enum getDefaultInstance()

parser

public static Parser<Enum> parser()

getParserForType

public Parser<Enum> getParserForType()

Description copied from class: GeneratedMessage

TODO: Remove this unnecessary intermediate implementation of this method.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

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