com.electronwill.nightconfig.core.serde.annotations

Enum SerdePhase

java.lang.Object

java.lang.Enum<SerdePhase>

com.electronwill.nightconfig.core.serde.annotations.SerdePhase

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SerdePhase>

public enum SerdePhase
extends java.lang.Enum<SerdePhase>

A serialization/deserialization phase.

Use this enum to specify when certain "serde" annotations apply.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH Apply the annotation when serializing and deserializing.
DESERIALIZING Only apply the annotation when deserializing.
SERIALIZING Only apply the annotation when serializing.

Method Summary

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

SERIALIZING

public static final SerdePhase SERIALIZING

Only apply the annotation when serializing.

DESERIALIZING

public static final SerdePhase DESERIALIZING

Only apply the annotation when deserializing.

BOTH

public static final SerdePhase BOTH

Apply the annotation when serializing and deserializing.

Method Detail

values

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

Returns:

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

valueOf

public static SerdePhase 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