Enum Class ConfigFormat

java.lang.Object

java.lang.Enum<ConfigFormat>

fr.hytale.loader.config.ConfigFormat

All Implemented Interfaces:

Serializable, Comparable<ConfigFormat>, Constable

public enum ConfigFormat
extends Enum<ConfigFormat>

Format of the configuration file.

Defines the supported file formats for plugin configurations.

Since:

1.0.4

Version:

1.0.4

Author:

HytaleLoader

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON	JSON format (config.json).
YAML	YAML format (config.yml).

Method Summary

Modifier and Type	Method	Description
String	getFileName()	Gets the default file name for this format.
static ConfigFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConfigFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

YAML

public static final ConfigFormat YAML

YAML format (config.yml). This is the default format used by Bukkit/Spigot plugins and defaults in HytaleLoader.

JSON

public static final ConfigFormat JSON

JSON format (config.json). A structured format widely used in web APIs and configuration.

Method Details

values

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

getFileName

public String getFileName()

Gets the default file name for this format.

Returns:

the file name (e.g. "config.yml" or "config.json")