com.google.protobuf

Class EnumValue

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.protobuf.EnumValue

All Implemented Interfaces:

EnumValueOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class EnumValue
extends GeneratedMessageV3
implements EnumValueOrBuilder

 Enum value definition.
 

Protobuf type google.protobuf.EnumValue

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnumValue.Builder Enum value 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_FIELD_NUMBER
static int	NUMBER_FIELD_NUMBER
static int	OPTIONS_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

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares the specified object with this message for equality.
static EnumValue	getDefaultInstance()
EnumValue	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
String	getName() Enum value name.
ByteString	getNameBytes() Enum value name.
int	getNumber() Enum value number.
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<EnumValue>	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.
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
int	hashCode() Returns the hash code value for this message.
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 EnumValue.Builder	newBuilder()
static EnumValue.Builder	newBuilder(EnumValue prototype)
EnumValue.Builder	newBuilderForType() Constructs a new builder for a message of the same type as this message.
protected EnumValue.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent) TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
static EnumValue	parseDelimitedFrom(InputStream input)
static EnumValue	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static EnumValue	parseFrom(byte[] data)
static EnumValue	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static EnumValue	parseFrom(ByteBuffer data)
static EnumValue	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static EnumValue	parseFrom(ByteString data)
static EnumValue	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static EnumValue	parseFrom(CodedInputStream input)
static EnumValue	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static EnumValue	parseFrom(InputStream input)
static EnumValue	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<EnumValue>	parser()
EnumValue.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, 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

NUMBER_FIELD_NUMBER

public static final int NUMBER_FIELD_NUMBER

See Also:

Constant Field Values

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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 value name.
 

string name = 1;

Specified by:

getName in interface EnumValueOrBuilder

getNameBytes

public ByteString getNameBytes()

 Enum value name.
 

string name = 1;

Specified by:

getNameBytes in interface EnumValueOrBuilder

getNumber

public int getNumber()

 Enum value number.
 

int32 number = 2;

Specified by:

getNumber in interface EnumValueOrBuilder

getOptionsList

public List<Option> getOptionsList()

 Protocol buffer options.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptionsList in interface EnumValueOrBuilder

getOptionsOrBuilderList

public List<? extends OptionOrBuilder> getOptionsOrBuilderList()

 Protocol buffer options.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptionsOrBuilderList in interface EnumValueOrBuilder

getOptionsCount

public int getOptionsCount()

 Protocol buffer options.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptionsCount in interface EnumValueOrBuilder

getOptions

public Option getOptions(int index)

 Protocol buffer options.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptions in interface EnumValueOrBuilder

getOptionsOrBuilder

public OptionOrBuilder getOptionsOrBuilder(int index)

 Protocol buffer options.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptionsOrBuilder in interface EnumValueOrBuilder

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.

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 EnumValue parseFrom(ByteBuffer data)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EnumValue parseFrom(ByteBuffer data,
                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EnumValue parseFrom(ByteString data)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EnumValue parseFrom(ByteString data,
                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EnumValue parseFrom(byte[] data)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EnumValue parseFrom(byte[] data,
                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static EnumValue parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static EnumValue parseFrom(InputStream input,
                  ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static EnumValue parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static EnumValue parseDelimitedFrom(InputStream input,
                           ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static EnumValue parseFrom(CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static EnumValue parseFrom(CodedInputStream input,
                  ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public EnumValue.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 EnumValue.Builder newBuilder()

newBuilder

public static EnumValue.Builder newBuilder(EnumValue prototype)

toBuilder

public EnumValue.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 EnumValue.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 EnumValue getDefaultInstance()

parser

public static Parser<EnumValue> parser()

getParserForType

public Parser<EnumValue> 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 EnumValue 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