Package com.google.ortools.util

Enum OptionalBoolean

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<OptionalBoolean>
    public enum OptionalBoolean
extends java.lang.Enum<OptionalBoolean>
implements com.google.protobuf.ProtocolMessageEnum
     A "three-way" boolean: unspecified, false or true.

 We don't use the value of 1 to increase the chance to catch bugs: eg. in
 python, a user may set a proto field of this type enum to a boolean value
 without type checks, if they set it to True, the proto validity code will
 catch it (because it'll be cast to 1, which is an invalid enum value).
 Note that if the user sets if to False (i.e. 0), it will be caught by the
 routing library's parameter validity check too.
    Protobuf enum operations_research.OptionalBoolean

    • Enum Constant Detail

      • BOOL_UNSPECIFIED

        public static final OptionalBoolean BOOL_UNSPECIFIED
        BOOL_UNSPECIFIED = 0;

      • BOOL_FALSE

        public static final OptionalBoolean BOOL_FALSE
        BOOL_FALSE = 2;

    • Field Detail

      • BOOL_UNSPECIFIED_VALUE

        public static final int BOOL_UNSPECIFIED_VALUE
        BOOL_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • BOOL_FALSE_VALUE

        public static final int BOOL_FALSE_VALUE
        BOOL_FALSE = 2;
        See Also:
        Constant Field Values

      • BOOL_TRUE_VALUE

        public static final int BOOL_TRUE_VALUE
        BOOL_TRUE = 3;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static OptionalBoolean[] 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 (OptionalBoolean c : OptionalBoolean.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static OptionalBoolean 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 OptionalBoolean 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 OptionalBoolean 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 com.google.protobuf.Internal.EnumLiteMap<OptionalBoolean> internalGetValueMap()

      • 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 OptionalBoolean 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