com.electronwill.nightconfig.core.serde.annotations

Enum SerdeSkipSerializingIf.SkipSerIf

java.lang.Object

java.lang.Enum<SerdeSkipSerializingIf.SkipSerIf>

com.electronwill.nightconfig.core.serde.annotations.SerdeSkipSerializingIf.SkipSerIf

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SerdeSkipSerializingIf.SkipSerIf>

Enclosing class:

SerdeSkipSerializingIf

public static enum SerdeSkipSerializingIf.SkipSerIf
extends java.lang.Enum<SerdeSkipSerializingIf.SkipSerIf>

A condition that defines when to skip the field during serialization.

The field is skipped if the condition is true.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Skip the field if its value satisfies a custom condition, defined by SerdeSkipSerializingIf.customCheck().
IS_EMPTY Skip the field if it's empty.
IS_NULL Skip the field if it's null.

Method Summary

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

public static final SerdeSkipSerializingIf.SkipSerIf IS_NULL

Skip the field if it's null.

IS_EMPTY

public static final SerdeSkipSerializingIf.SkipSerIf IS_EMPTY

Skip the field if it's 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.

CUSTOM

public static final SerdeSkipSerializingIf.SkipSerIf CUSTOM

Skip the field if its value satisfies a custom condition, defined by SerdeSkipSerializingIf.customCheck().

Method Detail

values

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

Returns:

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

valueOf

public static SerdeSkipSerializingIf.SkipSerIf 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