Package com.google.protobuf

Enum DescriptorProtos.FieldOptions.OptionRetention

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.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 com.google.protobuf.ProtocolMessageEnum
     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 enum google.protobuf.FieldOptions.OptionRetention

    • 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()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.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.

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static DescriptorProtos.FieldOptions.OptionRetention valueOf​(com.google.protobuf.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