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
,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 Internal.EnumLite
If set to RETENTION_SOURCE, the option will be omitted from the binary. Note: as of January 2023, support for this is in progress and does not yet have an effect (b/264593489).
Protobuf enumgoogle.protobuf.FieldOptions.OptionRetention
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
DescriptorProtos.FieldOptions.OptionRetention.OptionRetentionVerifier
-
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 private static Internal.EnumLiteMap<DescriptorProtos.FieldOptions.OptionRetention>
internalValueMap
static int
RETENTION_RUNTIME_VALUE
RETENTION_RUNTIME = 1;
static int
RETENTION_SOURCE_VALUE
RETENTION_SOURCE = 2;
static int
RETENTION_UNKNOWN_VALUE
RETENTION_UNKNOWN = 0;
private int
value
-
Constructor Summary
Constructors Modifier Constructor Description private
OptionRetention(int value)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static DescriptorProtos.FieldOptions.OptionRetention
forNumber(int value)
int
getNumber()
static Internal.EnumLiteMap<DescriptorProtos.FieldOptions.OptionRetention>
internalGetValueMap()
static Internal.EnumVerifier
internalGetVerifier()
static DescriptorProtos.FieldOptions.OptionRetention
valueOf(int value)
Deprecated.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.
-
-
-
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
-
internalValueMap
private static final Internal.EnumLiteMap<DescriptorProtos.FieldOptions.OptionRetention> internalValueMap
-
value
private final int value
-
-
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 namejava.lang.NullPointerException
- if the argument is null
-
getNumber
public final int getNumber()
- Specified by:
getNumber
in interfaceInternal.EnumLite
-
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 namejava.lang.NullPointerException
- if the argument is null
-
forNumber
public static DescriptorProtos.FieldOptions.OptionRetention forNumber(int value)
-
internalGetValueMap
public static Internal.EnumLiteMap<DescriptorProtos.FieldOptions.OptionRetention> internalGetValueMap()
-
internalGetVerifier
public static Internal.EnumVerifier internalGetVerifier()
-
-