Package net.mezzdev.config.api.migration

Enum Class ConfigMigrationStatus

java.lang.Object

java.lang.Enum<ConfigMigrationStatus>

net.mezzdev.config.api.migration.ConfigMigrationStatus

All Implemented Interfaces:

Serializable, Comparable<ConfigMigrationStatus>, Constable

public enum ConfigMigrationStatus
extends Enum<ConfigMigrationStatus>

Describes the outcome of a registered legacy config migration.

Since:

0.3.0

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
FAILED	Migration failed without applying any of its updates.
MIGRATED	The destination did not exist and the selected legacy file was migrated successfully.
SKIPPED_DESTINATION_EXISTS	The destination already existed, so migration was not attempted.
SKIPPED_INACTIVE	The migration target is permanently inactive, such as a client declaration on a dedicated server.
SKIPPED_NO_LEGACY_FILE	None of the registered legacy files existed, so migration was not attempted.

Method Summary

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

MIGRATED

public static final ConfigMigrationStatus MIGRATED

The destination did not exist and the selected legacy file was migrated successfully.

SKIPPED_DESTINATION_EXISTS

public static final ConfigMigrationStatus SKIPPED_DESTINATION_EXISTS

The destination already existed, so migration was not attempted.

SKIPPED_NO_LEGACY_FILE

public static final ConfigMigrationStatus SKIPPED_NO_LEGACY_FILE

None of the registered legacy files existed, so migration was not attempted.

SKIPPED_INACTIVE

public static final ConfigMigrationStatus SKIPPED_INACTIVE

The migration target is permanently inactive, such as a client declaration on a dedicated server.

FAILED

public static final ConfigMigrationStatus FAILED

Migration failed without applying any of its updates.

Method Details

values

public static ConfigMigrationStatus[] 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 ConfigMigrationStatus 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