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

Enum Class ConfigValueRestartRequirement

java.lang.Object

java.lang.Enum<ConfigValueRestartRequirement>

net.mezzdev.config.api.value.editor.ConfigValueRestartRequirement

All Implemented Interfaces:

Serializable, Comparable<ConfigValueRestartRequirement>, Constable

public enum ConfigValueRestartRequirement
extends Enum<ConfigValueRestartRequirement>

Defines when a saved config value becomes effective.

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
GAME_RESTART	Changes take effect after restarting the client game or dedicated server process.
NONE	Changes can take effect without a world, client game, or dedicated server restart.
WORLD_RESTART	Changes take effect after leaving and reopening a world.

Method Summary

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

NONE

public static final ConfigValueRestartRequirement NONE

Changes can take effect without a world, client game, or dedicated server restart.

Since:

0.1.0

WORLD_RESTART

public static final ConfigValueRestartRequirement WORLD_RESTART

Changes take effect after leaving and reopening a world. For a dedicated server, this normally means stopping and starting the server so that its world is loaded again.

Since:

0.1.0

GAME_RESTART

public static final ConfigValueRestartRequirement GAME_RESTART

Changes take effect after restarting the client game or dedicated server process.

Since:

0.1.0

Method Details

values

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