Module com.fasterxml.jackson.annotation
Package com.fasterxml.jackson.annotation

Enum Class OptBoolean

java.lang.Object
java.lang.Enum<OptBoolean>
com.fasterxml.jackson.annotation.OptBoolean
All Implemented Interfaces:
Serializable, Comparable<OptBoolean>, Constable
public enum OptBoolean extends Enum<OptBoolean>
Optional Boolean value ("nullean"). Needed just because Java annotations can not take 'null' as a value (even as default), so there is no way to distinguish between explicit `true` and `false`, and lack of choice (related: annotations are limited to primitives, so Boolean not allowed as solution).

Note: although the use of `true` and `false` would be more convenient, they can not be chosen since they are Java keyword and compiler won't allow the choice. And since enum naming convention suggests all-upper-case, that is what is done here.

  • Enum Constant Details

    • TRUE

      public static final OptBoolean TRUE
      Value that indicates that the annotation property is explicitly defined to be enabled, or true.

    • FALSE

      public static final OptBoolean FALSE
      Value that indicates that the annotation property is explicitly defined to be disabled, or false.

    • DEFAULT

      public static final OptBoolean DEFAULT
      Value that indicates that the annotation property does NOT have an explicit definition of enabled/disabled (or true/false); instead, a higher-level configuration value is used; or lacking higher-level global setting, default.

  • Method Details

    • values

      public static OptBoolean[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OptBoolean valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • asBoolean

      public Boolean asBoolean()

    • asPrimitive

      public boolean asPrimitive()

    • fromBoolean

      public static OptBoolean fromBoolean(Boolean b)

    • equals

      public static boolean equals(Boolean b1, Boolean b2)