com.fasterxml.jackson.annotation.Nulls Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jackson-annotations Show documentation

Core annotations used for value types, used by Jackson data binding package.

There is a newer version: 2.17.0

package com.fasterxml.jackson.annotation;

/**
 * Enumeration used with {@link 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.
 */
public enum Nulls
{
    /**
     * 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)
     */
    SET,

    /**
     * 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.
     */
    SKIP,

    /**
     * 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.
     */
    FAIL,

    /**
     * Value that indicates that value to assign should come from the value
     * deserializer of the type, using method getEmptyValue().
     */
    AS_EMPTY,

    /**
     * Pseudo-value used to indicate that defaults are to be used for handling,
     * that is, this value specifies no explicit handling override.
     */
    DEFAULT
    ;
}