Package tech.guilhermekaua.spigotboot.config.reference

Enum Class ReferenceTargetKind

java.lang.Object

java.lang.Enum<ReferenceTargetKind>

tech.guilhermekaua.spigotboot.config.reference.ReferenceTargetKind

All Implemented Interfaces:

Serializable, Comparable<ReferenceTargetKind>, Constable

public enum ReferenceTargetKind
extends Enum<ReferenceTargetKind>

Identifies the kind of target a config reference points to.

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
FOLDER_CONFIG_ITEM	References an item within a FolderConfig folder-based configuration.
SINGLE_CONFIG	References a single Config annotated configuration.

Method Summary

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

SINGLE_CONFIG

public static final ReferenceTargetKind SINGLE_CONFIG

References a single Config annotated configuration.

Examples:

• ${configName} - entire config root
• ${configName:path.to.value} - specific path within config

FOLDER_CONFIG_ITEM

public static final ReferenceTargetKind FOLDER_CONFIG_ITEM

References an item within a FolderConfig folder-based configuration.

Examples:

• ${folderConfigName.itemId} - entire item root
• ${folderConfigName.itemId:path.to.value} - specific path within item

Method Details

values

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