org.jsonschema2pojo

Enum InclusionLevel

java.lang.Object

java.lang.Enum<InclusionLevel>

org.jsonschema2pojo.InclusionLevel

All Implemented Interfaces:

Serializable, Comparable<InclusionLevel>

public enum InclusionLevel
extends Enum<InclusionLevel>

The level of inclusion to be set for generated java types (to control level of inclusion in case of Jackson serializer). Each level will have its own set of mapping annotations.

See Also:

JsonInclude.Include

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Value that indicates that property is to be always included, independent of value of the property.
NON_ABSENT Value that indicates that properties are included unless their value is: null "absent" value of a referential type (like Java 8 `Optional`, or {link java.utl.concurrent.atomic.AtomicReference}); that is, something that would not deference to a non-null value.
NON_DEFAULT Meaning of this setting depends on context: whether annotation is specified for POJO type (class), or not
NON_EMPTY Value that indicates that only properties with null value, or what is considered empty, are not to be included.
NON_NULL Value that indicates that only properties with non-null values are to be included.
USE_DEFAULTS Pseudo-value used to indicate that the higher-level defaults make sense, to avoid overriding inclusion value.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS

public static final InclusionLevel ALWAYS

Value that indicates that property is to be always included, independent of value of the property.

NON_ABSENT

public static final InclusionLevel NON_ABSENT

Value that indicates that properties are included unless their value is:

• null
• "absent" value of a referential type (like Java 8 `Optional`, or {link java.utl.concurrent.atomic.AtomicReference}); that is, something that would not deference to a non-null value.

NON_DEFAULT

public static final InclusionLevel NON_DEFAULT

Meaning of this setting depends on context: whether annotation is specified for POJO type (class), or not

NON_EMPTY

public static final InclusionLevel NON_EMPTY

Value that indicates that only properties with null value, or what is considered empty, are not to be included.

NON_NULL

public static final InclusionLevel NON_NULL

Value that indicates that only properties with non-null values are to be included.

USE_DEFAULTS

public static final InclusionLevel USE_DEFAULTS

Pseudo-value used to indicate that the higher-level defaults make sense, to avoid overriding inclusion value.

Method Detail

values

public static InclusionLevel[] 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 (InclusionLevel c : InclusionLevel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InclusionLevel valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null