dev.dejvokep.boostedyaml.settings.general

Enum GeneralSettings.KeyFormat

java.lang.Object

java.lang.Enum<GeneralSettings.KeyFormat>

dev.dejvokep.boostedyaml.settings.general.GeneralSettings.KeyFormat

All Implemented Interfaces:

Serializable, Comparable<GeneralSettings.KeyFormat>

Enclosing class:

GeneralSettings

public static enum GeneralSettings.KeyFormat
extends Enum<GeneralSettings.KeyFormat>

Key format for sections to use; specifies how the loaded/supplied keys should be formatted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OBJECT Allows anything as the key per the YAML specification (that is, integers, strings, doubles...).
STRING Allows only strings as keys.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRING

public static final GeneralSettings.KeyFormat STRING

Allows only strings as keys.

• All keys loaded are converted to strings via Object.toString() (e.g. 5 -> "5"), except null keys, which are considered illegal and will throw a NullPointerException. Please note that such conversion is irrevocable upon saving.
• String routes should only be used, as all keys are guaranteed to be strings. Routes can still be used, however, due to their capabilities, it is considered to be an overkill; all non-string keys supplied via those will internally be converted to strings (without modifying the route itself, they are immutable).

This key format ensures compatibility with Spigot/BungeeCord APIs.

OBJECT

public static final GeneralSettings.KeyFormat OBJECT

Allows anything as the key per the YAML specification (that is, integers, strings, doubles...).

• Preserves keys as they were loaded by SnakeYAML Engine (YAML processor), or supplied.
• Note that the only way to refer to data at routes that contain non-string keys is using Route. String routes can still be used, however, only to the extent of their limitations.

Method Detail

values

public static GeneralSettings.KeyFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GeneralSettings.KeyFormat c : GeneralSettings.KeyFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static GeneralSettings.KeyFormat valueOf(String name)

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

NullPointerException - if the argument is null