Package com.ultikits.ultitools.config.document

Enum Class ConfigLoadResult.State

java.lang.Object

java.lang.Enum<ConfigLoadResult.State>

com.ultikits.ultitools.config.document.ConfigLoadResult.State

All Implemented Interfaces:

Serializable, Comparable<ConfigLoadResult.State>, java.lang.constant.Constable

Enclosing class:

ConfigLoadResult

public static enum ConfigLoadResult.State
extends Enum<ConfigLoadResult.State>

The four outcomes of a load.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABSENT	No file exists at the path.
LOADED	The file was read and parsed; ConfigLoadResult.document() and ConfigLoadResult.fingerprint() are set.
UNPARSEABLE	The file was read but is not a document this layer reads; ConfigLoadResult.parserMessage() is set.
UNREADABLE	The file exists but reading it failed; ConfigLoadResult.cause() is set.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	State()

Method Summary

Modifier and Type	Method	Description
static ConfigLoadResult.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConfigLoadResult.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ABSENT

public static final ConfigLoadResult.State ABSENT

No file exists at the path.

LOADED

public static final ConfigLoadResult.State LOADED

The file was read and parsed; ConfigLoadResult.document() and ConfigLoadResult.fingerprint() are set.

UNREADABLE

public static final ConfigLoadResult.State UNREADABLE

The file exists but reading it failed; ConfigLoadResult.cause() is set.

UNPARSEABLE

public static final ConfigLoadResult.State UNPARSEABLE

The file was read but is not a document this layer reads; ConfigLoadResult.parserMessage() is set.

Constructor Details

State

private State()

Method Details

values

public static ConfigLoadResult.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ConfigLoadResult.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null