com.electronwill.nightconfig.core.serde.annotations

Enum SerdeAssert.AssertThat

java.lang.Object

java.lang.Enum<SerdeAssert.AssertThat>

com.electronwill.nightconfig.core.serde.annotations.SerdeAssert.AssertThat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SerdeAssert.AssertThat>

Enclosing class:

SerdeAssert

public static enum SerdeAssert.AssertThat
extends java.lang.Enum<SerdeAssert.AssertThat>

An condition that the field's value must verify during (de)serialization.

An exception is thrown if the field does not satisfy the condition.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Throw an exception if the field's value does not satisfy a custom condition, defined by SerdeAssert.customCheck().
NOT_EMPTY Throw an exception if the field is empty.
NOT_NULL Throw an exception if the field is null.

Method Summary

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

NOT_NULL

public static final SerdeAssert.AssertThat NOT_NULL

Throw an exception if the field is null.

NOT_EMPTY

public static final SerdeAssert.AssertThat NOT_EMPTY

Throw an exception if the field 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.

CUSTOM

public static final SerdeAssert.AssertThat CUSTOM

Throw an exception if the field's value does not satisfy a custom condition, defined by SerdeAssert.customCheck().

Method Detail

values

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

Returns:

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

valueOf

public static SerdeAssert.AssertThat 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