Package net.mezzdev.config.api.value.editor

Enum Class ConfigValueEditMode

java.lang.Object

java.lang.Enum<ConfigValueEditMode>

net.mezzdev.config.api.value.editor.ConfigValueEditMode

All Implemented Interfaces:

Serializable, Comparable<ConfigValueEditMode>, Constable

public enum ConfigValueEditMode
extends Enum<ConfigValueEditMode>

Hints how config editors should save edits for a config value.

MezzConfig stores this information but does not enforce it. Editors can use it to choose between immediate edits and batched edits.

Since:

0.1.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
BATCH	Editors should stage changes and save them together when the user applies pending changes.
IMMEDIATE	Editors can save changes as soon as the user makes them.

Method Summary

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

IMMEDIATE

public static final ConfigValueEditMode IMMEDIATE

Editors can save changes as soon as the user makes them.

Since:

0.1.0

BATCH

public static final ConfigValueEditMode BATCH

Editors should stage changes and save them together when the user applies pending changes.

Since:

0.1.0

Method Details

values

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