com.electronwill.nightconfig.core.serde.annotations

Enum SerdeDefault.WhenValue

java.lang.Object

java.lang.Enum<SerdeDefault.WhenValue>

com.electronwill.nightconfig.core.serde.annotations.SerdeDefault.WhenValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SerdeDefault.WhenValue>

Enclosing class:

SerdeDefault

public static enum SerdeDefault.WhenValue
extends java.lang.Enum<SerdeDefault.WhenValue>

A condition that defines when to use the default value during (de)serialization.

The default value is used if the condition is true.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IS_EMPTY When deserializing a field, set it to its default value if the value from the config is empty.
IS_MISSING When deserializing a field, call the default value provider if the value is missing from the config.
IS_NULL When deserializing a field, set it to its default value if the value from the config is null.

Method Summary

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

IS_MISSING

public static final SerdeDefault.WhenValue IS_MISSING

When deserializing a field, call the default value provider if the value is missing from the config.

This does nothing when serializing, because a field cannot be missing.

IS_NULL

public static final SerdeDefault.WhenValue IS_NULL

When deserializing a field, set it to its default value if the value from the config is null.

When serializing a field, serialize the default value instead of the field's value if the latter is null.

IS_EMPTY

public static final SerdeDefault.WhenValue IS_EMPTY

When deserializing a field, set it to its default value if the value from the config is empty.

When serializing a field, serialize the default value instead of the field's value if the latter is empty.

Determining whether an object is "empty" or not is done in a "logical" way for common Java objects. For instance, a CharSequence is empty is its length() is zero, a Collection is empty if calling isEmpty() returns true, etc. As a last-resort try to implement the "is empty" check, reflection is used to find and call the method boolean isEmpty() on the value.

Method Detail

values

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

Returns:

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

valueOf

public static SerdeDefault.WhenValue 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