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

Enum Class Nulls

java.lang.Object
java.lang.Enum<Nulls>
com.fasterxml.jackson.annotation.Nulls
All Implemented Interfaces:
Serializable, Comparable<Nulls>, Constable
public enum Nulls extends Enum<Nulls>
Enumeration used with JsonSetter (for properties `nulls` and `contentNulls`) to define how explicit `null` values from input (if input format has the concept; JSON, for example does) are handled.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AS_EMPTY
    Value that indicates that value to assign should come from the value deserializer of the type, using method getEmptyValue().
    DEFAULT
    Pseudo-value used to indicate that defaults are to be used for handling, that is, this value specifies no explicit handling override.
    FAIL
    Value that indicates that an exception (of type that indicates input mismatch problem) is to be thrown, to indicate that null values are not accepted.
    SET
    Value that indicates that an input null should result in assignment of Java `null` value of matching property (except where deserializer indicates other "null value" by overriding getNullValue(...) method)
    SKIP
    Value that indicates that an input null value should be skipped and no assignment is to be made; this usually means that the property will have its default value.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Nulls
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Nulls[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • SET

      public static final Nulls SET
      Value that indicates that an input null should result in assignment of Java `null` value of matching property (except where deserializer indicates other "null value" by overriding getNullValue(...) method)

    • SKIP

      public static final Nulls SKIP
      Value that indicates that an input null value should be skipped and no assignment is to be made; this usually means that the property will have its default value.

    • FAIL

      public static final Nulls FAIL
      Value that indicates that an exception (of type that indicates input mismatch problem) is to be thrown, to indicate that null values are not accepted.

    • AS_EMPTY

      public static final Nulls AS_EMPTY
      Value that indicates that value to assign should come from the value deserializer of the type, using method getEmptyValue().

    • DEFAULT

      public static final Nulls DEFAULT
      Pseudo-value used to indicate that defaults are to be used for handling, that is, this value specifies no explicit handling override.

  • Method Details

    • values

      public static Nulls[] 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 Nulls 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