Class DescriptorProtos.EnumOptions (3.19.4)

public static final class DescriptorProtos.EnumOptions extends GeneratedMessageV3.ExtendableMessage<DescriptorProtos.EnumOptions> implements DescriptorProtos.EnumOptionsOrBuilder

Protobuf type google.protobuf.EnumOptions

Static Fields

ALLOW_ALIAS_FIELD_NUMBER

public static final int ALLOW_ALIAS_FIELD_NUMBER
Field Value
Type Description
int

DEPRECATED_FIELD_NUMBER

public static final int DEPRECATED_FIELD_NUMBER
Field Value
Type Description
int

PARSER

public static final Parser<DescriptorProtos.EnumOptions> PARSER
Field Value
Type Description
Parser<EnumOptions>

UNINTERPRETED_OPTION_FIELD_NUMBER

public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DescriptorProtos.EnumOptions getDefaultInstance()
Returns
Type Description
DescriptorProtos.EnumOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptors.Descriptor

newBuilder()

public static DescriptorProtos.EnumOptions.Builder newBuilder()
Returns
Type Description
DescriptorProtos.EnumOptions.Builder

newBuilder(DescriptorProtos.EnumOptions prototype)

public static DescriptorProtos.EnumOptions.Builder newBuilder(DescriptorProtos.EnumOptions prototype)
Parameter
Name Description
prototype DescriptorProtos.EnumOptions
Returns
Type Description
DescriptorProtos.EnumOptions.Builder

parseDelimitedFrom(InputStream input)

public static DescriptorProtos.EnumOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DescriptorProtos.EnumOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DescriptorProtos.EnumOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DescriptorProtos.EnumOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DescriptorProtos.EnumOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DescriptorProtos.EnumOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DescriptorProtos.EnumOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescriptorProtos.EnumOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DescriptorProtos.EnumOptions> parser()
Returns
Type Description
Parser<EnumOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)

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.

Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowAlias()

public boolean getAllowAlias()

Set this option to true to allow mapping different tag names to the same value.

optional bool allow_alias = 2;

Returns
Type Description
boolean

The allowAlias.

getDefaultInstanceForType()

public DescriptorProtos.EnumOptions getDefaultInstanceForType()

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.

Returns
Type Description
DescriptorProtos.EnumOptions

getDeprecated()

public boolean getDeprecated()

Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums.

optional bool deprecated = 3 [default = false];

Returns
Type Description
boolean

The deprecated.

getParserForType()

public Parser<DescriptorProtos.EnumOptions> getParserForType()
Returns
Type Description
Parser<EnumOptions>
Overrides

getSerializedSize()

public int getSerializedSize()

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.

Returns
Type Description
int
Overrides

getUninterpretedOption(int index)

public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name Description
index int
Returns
Type Description
DescriptorProtos.UninterpretedOption

getUninterpretedOptionCount()

public int getUninterpretedOptionCount()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type Description
int

getUninterpretedOptionList()

public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type Description
List<UninterpretedOption>

getUninterpretedOptionOrBuilder(int index)

public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name Description
index int
Returns
Type Description
DescriptorProtos.UninterpretedOptionOrBuilder

getUninterpretedOptionOrBuilderList()

public List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type Description
List<? extends com.google.protobuf.DescriptorProtos.UninterpretedOptionOrBuilder>

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

Returns
Type Description
UnknownFieldSet
Overrides

hasAllowAlias()

public boolean hasAllowAlias()

Set this option to true to allow mapping different tag names to the same value.

optional bool allow_alias = 2;

Returns
Type Description
boolean

Whether the allowAlias field is set.

hasDeprecated()

public boolean hasDeprecated()

Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums.

optional bool deprecated = 3 [default = false];

Returns
Type Description
boolean

Whether the deprecated field is set.

hashCode()

public int hashCode()

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.

Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

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.

Returns
Type Description
GeneratedMessageV3.FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder#getInitializationErrorString()

Returns
Type Description
boolean
Overrides

newBuilderForType()

public DescriptorProtos.EnumOptions.Builder newBuilderForType()
Returns
Type Description
DescriptorProtos.EnumOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DescriptorProtos.EnumOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.

Parameter
Name Description
parent GeneratedMessageV3.BuilderParent
Returns
Type Description
DescriptorProtos.EnumOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Creates a new instance of this message type. Overridden in the generated code.

Parameter
Name Description
unused GeneratedMessageV3.UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DescriptorProtos.EnumOptions.Builder toBuilder()
Returns
Type Description
DescriptorProtos.EnumOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Serializes the message and writes it to output. This does not flush or close the stream.

Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException