Package com.google.protobuf
Class Enum
- java.lang.Object
-
- All Implemented Interfaces:
EnumOrBuilder,Message,MessageLite,MessageLiteOrBuilder,MessageOrBuilder,java.io.Serializable
public final class Enum extends GeneratedMessage implements EnumOrBuilder
Enum type definition.
Protobuf typegoogle.protobuf.Enum- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classEnum.BuilderEnum type definition.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
GeneratedMessage.ExtendableBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, GeneratedMessage.ExtendableMessage<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>, GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>, GeneratedMessage.ExtensionDescriptorRetriever, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingT extends Message,T>, GeneratedMessage.UnusedPrivateParameter
-
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
AbstractMessage.BuilderParent
-
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
-
Field Summary
Fields Modifier and Type Field Description private intbitField0_private static EnumDEFAULT_INSTANCEprivate java.lang.Objectedition_static intEDITION_FIELD_NUMBERprivate java.util.List<EnumValue>enumvalue_static intENUMVALUE_FIELD_NUMBERprivate bytememoizedIsInitializedprivate java.lang.Objectname_static intNAME_FIELD_NUMBERprivate java.util.List<Option>options_static intOPTIONS_FIELD_NUMBERprivate static Parser<Enum>PARSERprivate static longserialVersionUIDstatic intSOURCE_CONTEXT_FIELD_NUMBERprivate SourceContextsourceContext_private intsyntax_static intSYNTAX_FIELD_NUMBER-
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
-
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
-
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
-
Constructor Summary
Constructors Modifier Constructor Description privateEnum()privateEnum(GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)Compares the specified object with this message for equality.static EnumgetDefaultInstance()EnumgetDefaultInstanceForType()Get an instance of the type with no fields set.static Descriptors.DescriptorgetDescriptor()java.lang.StringgetEdition()The source edition string, only valid when syntax is SYNTAX_EDITIONS.ByteStringgetEditionBytes()The source edition string, only valid when syntax is SYNTAX_EDITIONS.EnumValuegetEnumvalue(int index)Enum value definitions.intgetEnumvalueCount()Enum value definitions.java.util.List<EnumValue>getEnumvalueList()Enum value definitions.EnumValueOrBuildergetEnumvalueOrBuilder(int index)Enum value definitions.java.util.List<? extends EnumValueOrBuilder>getEnumvalueOrBuilderList()Enum value definitions.java.lang.StringgetName()Enum type name.ByteStringgetNameBytes()Enum type name.OptiongetOptions(int index)Protocol buffer options.intgetOptionsCount()Protocol buffer options.java.util.List<Option>getOptionsList()Protocol buffer options.OptionOrBuildergetOptionsOrBuilder(int index)Protocol buffer options.java.util.List<? extends OptionOrBuilder>getOptionsOrBuilderList()Protocol buffer options.Parser<Enum>getParserForType()TODO: Remove this unnecessary intermediate implementation of this method.intgetSerializedSize()Get the number of bytes required to encode this message.SourceContextgetSourceContext()The source context.SourceContextOrBuildergetSourceContextOrBuilder()The source context.SyntaxgetSyntax()The source syntax.intgetSyntaxValue()The source syntax.inthashCode()Returns the hash code value for this message.booleanhasSourceContext()The source context.protected GeneratedMessage.FieldAccessorTableinternalGetFieldAccessorTable()Get the FieldAccessorTable for this type.booleanisInitialized()Returns true if all required fields in the message and all embedded messages are set, false otherwise.static Enum.BuildernewBuilder()static Enum.BuildernewBuilder(Enum prototype)Enum.BuildernewBuilderForType()Constructs a new builder for a message of the same type as this message.protected Enum.BuildernewBuilderForType(AbstractMessage.BuilderParent parent)Create a nested builder.static EnumparseDelimitedFrom(java.io.InputStream input)static EnumparseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)static EnumparseFrom(byte[] data)static EnumparseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)static EnumparseFrom(ByteString data)static EnumparseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)static EnumparseFrom(CodedInputStream input)static EnumparseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)static EnumparseFrom(java.io.InputStream input)static EnumparseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)static EnumparseFrom(java.nio.ByteBuffer data)static EnumparseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)static Parser<Enum>parser()Enum.BuildertoBuilder()Constructs a builder initialized with the current message.voidwriteTo(CodedOutputStream output)Serializes the message and writes it tooutput.-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getDescriptorForType, getField, getFieldRaw, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, setUnknownFields, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashFields, newUninitializedMessageException, setMemoizedSerializedSize, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, getSerializedSize, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Field Detail
-
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 java.lang.Object name_
-
ENUMVALUE_FIELD_NUMBER
public static final int ENUMVALUE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
enumvalue_
private java.util.List<EnumValue> enumvalue_
-
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
options_
private java.util.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 java.lang.Object edition_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final Enum DEFAULT_INSTANCE
-
-
Constructor Detail
-
Enum
private Enum(GeneratedMessage.Builder<?> builder)
-
Enum
private Enum()
-
-
Method Detail
-
getDescriptor
public static final Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Description copied from class:GeneratedMessageGet 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:
internalGetFieldAccessorTablein classGeneratedMessage
-
getName
public java.lang.String getName()
Enum type name.
string name = 1;- Specified by:
getNamein interfaceEnumOrBuilder- Returns:
- The name.
-
getNameBytes
public ByteString getNameBytes()
Enum type name.
string name = 1;- Specified by:
getNameBytesin interfaceEnumOrBuilder- Returns:
- The bytes for name.
-
getEnumvalueList
public java.util.List<EnumValue> getEnumvalueList()
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;- Specified by:
getEnumvalueListin interfaceEnumOrBuilder
-
getEnumvalueOrBuilderList
public java.util.List<? extends EnumValueOrBuilder> getEnumvalueOrBuilderList()
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;- Specified by:
getEnumvalueOrBuilderListin interfaceEnumOrBuilder
-
getEnumvalueCount
public int getEnumvalueCount()
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;- Specified by:
getEnumvalueCountin interfaceEnumOrBuilder
-
getEnumvalue
public EnumValue getEnumvalue(int index)
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;- Specified by:
getEnumvaluein interfaceEnumOrBuilder
-
getEnumvalueOrBuilder
public EnumValueOrBuilder getEnumvalueOrBuilder(int index)
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;- Specified by:
getEnumvalueOrBuilderin interfaceEnumOrBuilder
-
getOptionsList
public java.util.List<Option> getOptionsList()
Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsListin interfaceEnumOrBuilder
-
getOptionsOrBuilderList
public java.util.List<? extends OptionOrBuilder> getOptionsOrBuilderList()
Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsOrBuilderListin interfaceEnumOrBuilder
-
getOptionsCount
public int getOptionsCount()
Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsCountin interfaceEnumOrBuilder
-
getOptions
public Option getOptions(int index)
Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsin interfaceEnumOrBuilder
-
getOptionsOrBuilder
public OptionOrBuilder getOptionsOrBuilder(int index)
Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsOrBuilderin interfaceEnumOrBuilder
-
hasSourceContext
public boolean hasSourceContext()
The source context.
.google.protobuf.SourceContext source_context = 4;- Specified by:
hasSourceContextin interfaceEnumOrBuilder- Returns:
- Whether the sourceContext field is set.
-
getSourceContext
public SourceContext getSourceContext()
The source context.
.google.protobuf.SourceContext source_context = 4;- Specified by:
getSourceContextin interfaceEnumOrBuilder- Returns:
- The sourceContext.
-
getSourceContextOrBuilder
public SourceContextOrBuilder getSourceContextOrBuilder()
The source context.
.google.protobuf.SourceContext source_context = 4;- Specified by:
getSourceContextOrBuilderin interfaceEnumOrBuilder
-
getSyntaxValue
public int getSyntaxValue()
The source syntax.
.google.protobuf.Syntax syntax = 5;- Specified by:
getSyntaxValuein interfaceEnumOrBuilder- Returns:
- The enum numeric value on the wire for syntax.
-
getSyntax
public Syntax getSyntax()
The source syntax.
.google.protobuf.Syntax syntax = 5;- Specified by:
getSyntaxin interfaceEnumOrBuilder- Returns:
- The syntax.
-
getEdition
public java.lang.String getEdition()
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
string edition = 6;- Specified by:
getEditionin interfaceEnumOrBuilder- Returns:
- The edition.
-
getEditionBytes
public ByteString getEditionBytes()
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
string edition = 6;- Specified by:
getEditionBytesin interfaceEnumOrBuilder- Returns:
- The bytes for edition.
-
isInitialized
public final boolean isInitialized()
Description copied from interface:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessage
-
writeTo
public void writeTo(CodedOutputStream output) throws java.io.IOException
Description copied from interface:MessageLiteSerializes the message and writes it tooutput. This does not flush or close the stream.- Specified by:
writeToin interfaceMessageLite- Overrides:
writeToin classGeneratedMessage- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
Description copied from interface:MessageLiteGet 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:
getSerializedSizein interfaceMessageLite- Overrides:
getSerializedSizein classGeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
Description copied from interface:MessageCompares the specified object with this message for equality. Returnstrueif the given object is a message of the same type (as defined bygetDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheritingObject.equals()is incorrect.- Specified by:
equalsin interfaceMessage- Overrides:
equalsin classAbstractMessage- Parameters:
obj- object to be compared for equality with this message- Returns:
trueif the specified object is equal to this message
-
hashCode
public int hashCode()
Description copied from interface:MessageReturns 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; inheritingObject.hashCode()is incorrect.- Specified by:
hashCodein interfaceMessage- Overrides:
hashCodein classAbstractMessage- Returns:
- the hash code value for this message
- See Also:
Map.hashCode()
-
parseFrom
public static Enum parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Enum parseFrom(java.nio.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(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Enum parseFrom(java.io.InputStream input, 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, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Enum parseFrom(CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Enum parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Enum.Builder newBuilderForType()
Description copied from interface:MessageLiteConstructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForTypein interfaceMessage- Specified by:
newBuilderForTypein interfaceMessageLite
-
newBuilder
public static Enum.Builder newBuilder()
-
newBuilder
public static Enum.Builder newBuilder(Enum prototype)
-
toBuilder
public Enum.Builder toBuilder()
Description copied from interface:MessageLiteConstructs a builder initialized with the current message. Use this to derive a new message from the current one.- Specified by:
toBuilderin interfaceMessage- Specified by:
toBuilderin interfaceMessageLite
-
newBuilderForType
protected Enum.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Description copied from class:AbstractMessageCreate a nested builder.- Overrides:
newBuilderForTypein classAbstractMessage
-
getDefaultInstance
public static Enum getDefaultInstance()
-
getParserForType
public Parser<Enum> getParserForType()
Description copied from class:GeneratedMessageTODO: Remove this unnecessary intermediate implementation of this method.- Specified by:
getParserForTypein interfaceMessage- Specified by:
getParserForTypein interfaceMessageLite- Overrides:
getParserForTypein classGeneratedMessage
-
getDefaultInstanceForType
public Enum getDefaultInstanceForType()
Description copied from interface:MessageLiteOrBuilderGet 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 thegetDefaultInstance()method of generated message classes in that this method is an abstract method of theMessageLiteinterface whereasgetDefaultInstance()is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-
-