Package com.google.protobuf
Class Enum
- All Implemented Interfaces:
EnumOrBuilder
,Message
,MessageLite
,MessageLiteOrBuilder
,MessageOrBuilder
,Serializable
Enum type definition.Protobuf type
google.protobuf.Enum
- See Also:
-
Nested Class Summary
Nested ClassesNested 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.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Enum
static final int
private byte
private Object
static final int
static final int
private static final long
static final int
private SourceContext
private int
static final int
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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the specified object with this message for equality.static Enum
Get an instance of the type with no fields set.static final Descriptors.Descriptor
getEnumvalue
(int index) Enum value definitions.int
Enum value definitions.Enum value definitions.getEnumvalueOrBuilder
(int index) Enum value definitions.List
<? extends EnumValueOrBuilder> Enum value definitions.getName()
Enum type name.Enum type name.getOptions
(int index) Protocol buffer options.int
Protocol buffer options.Protocol buffer options.getOptionsOrBuilder
(int index) Protocol buffer options.List
<? extends OptionOrBuilder> Protocol buffer options.Gets the parser for a message of the same type as this message.int
Get the number of bytes required to encode this message.The source context.The source context.The source syntax.int
The source syntax.final UnknownFieldSet
Get theUnknownFieldSet
for this message.int
hashCode()
Returns the hash code value for this message.boolean
The source context.protected GeneratedMessageV3.FieldAccessorTable
Get the FieldAccessorTable for this type.final boolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.static Enum.Builder
static Enum.Builder
newBuilder
(Enum prototype) Constructs a new builder for a message of the same type as this message.protected Enum.Builder
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.protected Object
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
(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) parser()
Constructs a builder initialized with the current message.void
writeTo
(CodedOutputStream output) Serializes the message and writes it tooutput
.Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getDescriptorForType, getField, getFieldRaw, 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, setAlwaysUseFieldBuildersForTesting, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
name_
-
ENUMVALUE_FIELD_NUMBER
public static final int ENUMVALUE_FIELD_NUMBER- See Also:
-
enumvalue_
-
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER- See Also:
-
options_
-
SOURCE_CONTEXT_FIELD_NUMBER
public static final int SOURCE_CONTEXT_FIELD_NUMBER- See Also:
-
sourceContext_
-
SYNTAX_FIELD_NUMBER
public static final int SYNTAX_FIELD_NUMBER- See Also:
-
syntax_
private int syntax_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
Enum
-
Enum
private Enum()
-
-
Method Details
-
newInstance
Description copied from class:GeneratedMessageV3
Creates a new instance of this message type. Overridden in the generated code.- Overrides:
newInstance
in classGeneratedMessageV3
-
getUnknownFields
Description copied from interface:MessageOrBuilder
Get theUnknownFieldSet
for this message.- Specified by:
getUnknownFields
in interfaceMessageOrBuilder
- Overrides:
getUnknownFields
in classGeneratedMessageV3
-
getDescriptor
-
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 classGeneratedMessageV3
-
getName
Enum type name.
string name = 1;
- Specified by:
getName
in interfaceEnumOrBuilder
- Returns:
- The name.
-
getNameBytes
Enum type name.
string name = 1;
- Specified by:
getNameBytes
in interfaceEnumOrBuilder
- Returns:
- The bytes for name.
-
getEnumvalueList
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalueList
in interfaceEnumOrBuilder
-
getEnumvalueOrBuilderList
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalueOrBuilderList
in interfaceEnumOrBuilder
-
getEnumvalueCount
public int getEnumvalueCount()Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalueCount
in interfaceEnumOrBuilder
-
getEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalue
in interfaceEnumOrBuilder
-
getEnumvalueOrBuilder
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalueOrBuilder
in interfaceEnumOrBuilder
-
getOptionsList
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsList
in interfaceEnumOrBuilder
-
getOptionsOrBuilderList
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsOrBuilderList
in interfaceEnumOrBuilder
-
getOptionsCount
public int getOptionsCount()Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsCount
in interfaceEnumOrBuilder
-
getOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptions
in interfaceEnumOrBuilder
-
getOptionsOrBuilder
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsOrBuilder
in interfaceEnumOrBuilder
-
hasSourceContext
public boolean hasSourceContext()The source context.
.google.protobuf.SourceContext source_context = 4;
- Specified by:
hasSourceContext
in interfaceEnumOrBuilder
- Returns:
- Whether the sourceContext field is set.
-
getSourceContext
The source context.
.google.protobuf.SourceContext source_context = 4;
- Specified by:
getSourceContext
in interfaceEnumOrBuilder
- Returns:
- The sourceContext.
-
getSourceContextOrBuilder
The source context.
.google.protobuf.SourceContext source_context = 4;
- Specified by:
getSourceContextOrBuilder
in interfaceEnumOrBuilder
-
getSyntaxValue
public int getSyntaxValue()The source syntax.
.google.protobuf.Syntax syntax = 5;
- Specified by:
getSyntaxValue
in interfaceEnumOrBuilder
- Returns:
- The enum numeric value on the wire for syntax.
-
getSyntax
The source syntax.
.google.protobuf.Syntax syntax = 5;
- Specified by:
getSyntax
in interfaceEnumOrBuilder
- 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.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessageV3
-
writeTo
Description copied from interface:MessageLite
Serializes the message and writes it tooutput
. This does not flush or close the stream.- Specified by:
writeTo
in interfaceMessageLite
- Overrides:
writeTo
in classGeneratedMessageV3
- 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 interfaceMessageLite
- Overrides:
getSerializedSize
in classGeneratedMessageV3
-
equals
Description copied from interface:Message
Compares the specified object with this message for equality. Returnstrue
if 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:
equals
in interfaceMessage
- Overrides:
equals
in classAbstractMessage
- 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; inheritingObject.hashCode()
is incorrect.- Specified by:
hashCode
in interfaceMessage
- Overrides:
hashCode
in classAbstractMessage
- Returns:
- the hash code value for this message
- See Also:
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Enum parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Enum parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Enum parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Enum parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Enum parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Enum parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
Description copied from interface:MessageLite
Constructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForType
in interfaceMessage
- Specified by:
newBuilderForType
in interfaceMessageLite
-
newBuilder
-
newBuilder
-
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 interfaceMessage
- Specified by:
toBuilder
in interfaceMessageLite
-
newBuilderForType
Description copied from class:GeneratedMessageV3
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.- Specified by:
newBuilderForType
in classGeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
Description copied from interface:MessageLite
Gets the parser for a message of the same type as this message.- Specified by:
getParserForType
in interfaceMessage
- Specified by:
getParserForType
in interfaceMessageLite
- Overrides:
getParserForType
in classGeneratedMessageV3
-
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 thegetDefaultInstance()
method of generated message classes in that this method is an abstract method of theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder
-