io.micronaut.serde.config.annotation

Enum SerdeConfig.SerInclude

java.lang.Object

java.lang.Enum<SerdeConfig.SerInclude>

io.micronaut.serde.config.annotation.SerdeConfig.SerInclude

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SerdeConfig.SerInclude>

Enclosing class:

SerdeConfig

public static enum SerdeConfig.SerInclude
extends java.lang.Enum<SerdeConfig.SerInclude>

Include strategies for serialization.

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.
NEVER Ignore 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.util.concurrent.atomic.AtomicReference}); that is, something that would not deference to a non-null value.
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.

Method Summary

Modifier and Type	Method and Description
static SerdeConfig.SerInclude	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SerdeConfig.SerInclude[]	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 SerdeConfig.SerInclude ALWAYS

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

NON_NULL

public static final SerdeConfig.SerInclude NON_NULL

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

NON_ABSENT

public static final SerdeConfig.SerInclude 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.util.concurrent.atomic.AtomicReference}); that is, something that would not deference to a non-null value.

NON_EMPTY

public static final SerdeConfig.SerInclude NON_EMPTY

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

NEVER

public static final SerdeConfig.SerInclude NEVER

Ignore the property.

Method Detail

values

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

Returns:

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

valueOf

public static SerdeConfig.SerInclude 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