Package com.google.protobuf

Enum DescriptorProtos.FieldOptions.OptionRetention

java.lang.Object

java.lang.Enum<DescriptorProtos.FieldOptions.OptionRetention>

com.google.protobuf.DescriptorProtos.FieldOptions.OptionRetention

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<DescriptorProtos.FieldOptions.OptionRetention>

Enclosing class:

DescriptorProtos.FieldOptions

public static enum DescriptorProtos.FieldOptions.OptionRetention
extends java.lang.Enum<DescriptorProtos.FieldOptions.OptionRetention>
implements ProtocolMessageEnum

Protobuf enum google.protobuf.FieldOptions.OptionRetention

Enum Constant Summary

Enum Constants

Enum Constant	Description
RETENTION_RUNTIME	RETENTION_RUNTIME = 1;
RETENTION_SOURCE	RETENTION_SOURCE = 2;
RETENTION_UNKNOWN	RETENTION_UNKNOWN = 0;

Field Summary

Fields

Modifier and Type	Field	Description
static int	RETENTION_RUNTIME_VALUE	RETENTION_RUNTIME = 1;
static int	RETENTION_SOURCE_VALUE	RETENTION_SOURCE = 2;
static int	RETENTION_UNKNOWN_VALUE	RETENTION_UNKNOWN = 0;

Method Summary

Modifier and Type	Method	Description
static DescriptorProtos.FieldOptions.OptionRetention	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()	Return the enum type's descriptor, which contains information about each defined value, etc.
int	getNumber()	Return the value's numeric value as defined in the .proto file.
Descriptors.EnumValueDescriptor	getValueDescriptor()	Return the value's descriptor, which contains information such as value name, number, and type.
static Internal.EnumLiteMap<DescriptorProtos.FieldOptions.OptionRetention>	internalGetValueMap()
static DescriptorProtos.FieldOptions.OptionRetention	valueOf(int value)	Deprecated.
static DescriptorProtos.FieldOptions.OptionRetention	valueOf(Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static DescriptorProtos.FieldOptions.OptionRetention	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static DescriptorProtos.FieldOptions.OptionRetention[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RETENTION_UNKNOWN

public static final DescriptorProtos.FieldOptions.OptionRetention RETENTION_UNKNOWN

RETENTION_UNKNOWN = 0;

RETENTION_RUNTIME

public static final DescriptorProtos.FieldOptions.OptionRetention RETENTION_RUNTIME

RETENTION_RUNTIME = 1;

RETENTION_SOURCE

public static final DescriptorProtos.FieldOptions.OptionRetention RETENTION_SOURCE

RETENTION_SOURCE = 2;

Field Detail

RETENTION_UNKNOWN_VALUE

public static final int RETENTION_UNKNOWN_VALUE

RETENTION_UNKNOWN = 0;

See Also:

Constant Field Values

RETENTION_RUNTIME_VALUE

public static final int RETENTION_RUNTIME_VALUE

RETENTION_RUNTIME = 1;

See Also:

Constant Field Values

RETENTION_SOURCE_VALUE

public static final int RETENTION_SOURCE_VALUE

RETENTION_SOURCE = 2;

See Also:

Constant Field Values

Method Detail

values

public static DescriptorProtos.FieldOptions.OptionRetention[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DescriptorProtos.FieldOptions.OptionRetention c : DescriptorProtos.FieldOptions.OptionRetention.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DescriptorProtos.FieldOptions.OptionRetention valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNumber

public final int getNumber()

Description copied from interface: ProtocolMessageEnum

Return the value's numeric value as defined in the .proto file.

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static DescriptorProtos.FieldOptions.OptionRetention valueOf(int value)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

value - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

forNumber

public static DescriptorProtos.FieldOptions.OptionRetention forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static Internal.EnumLiteMap<DescriptorProtos.FieldOptions.OptionRetention> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Description copied from interface: ProtocolMessageEnum

Return the value's descriptor, which contains information such as value name, number, and type.

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Description copied from interface: ProtocolMessageEnum

Return the enum type's descriptor, which contains information about each defined value, etc.

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static DescriptorProtos.FieldOptions.OptionRetention valueOf(Descriptors.EnumValueDescriptor desc)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

desc - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null