com.codelanx.codelanxlib.config

Enum DefaultLang

java.lang.Object

java.lang.Enum<DefaultLang>

com.codelanx.codelanxlib.config.DefaultLang

All Implemented Interfaces:

Lang, PluginFile, Serializable, Comparable<DefaultLang>

public enum DefaultLang
extends Enum<DefaultLang>
implements Lang

Class description for DefaultLang

Since:

1.0.0

Version:

1.0.0

Author:

1Rogue

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOT_A_NUMBER
NOT_POSITIVE
PLAYER_NEVER_PLAYED
PLAYER_NOT_ONLINE
UNKNOWN_PLAYER

Method Summary

Modifier and Type	Method and Description
DataHolder<Yaml>	getData() Returns the relevant DataHolder for this file, which provides thread-safety for the FileDataType object initialization
String	getDefault() The default value of this Lang string
Lang	getFormat() Returns the format specifier for this Lang file.
String	getPath() The FileDataType path to store this value in
static DefaultLang	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultLang[]	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

Methods inherited from interface com.codelanx.codelanxlib.config.Lang

color, createLang, defaultFormat, format, formatAndColor, get, getFormat, pluralFormat, proper, proper, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendRawMessage, sendRawMessage, sendRawMessage, sendTitle, tellRaw

Methods inherited from interface com.codelanx.codelanxlib.config.PluginFile

getConfig, getFileLocation, init, save, save

Enum Constant Detail

PLAYER_NOT_ONLINE

public static final DefaultLang PLAYER_NOT_ONLINE

PLAYER_NEVER_PLAYED

public static final DefaultLang PLAYER_NEVER_PLAYED

UNKNOWN_PLAYER

public static final DefaultLang UNKNOWN_PLAYER

NOT_A_NUMBER

public static final DefaultLang NOT_A_NUMBER

NOT_POSITIVE

public static final DefaultLang NOT_POSITIVE

Method Detail

values

public static DefaultLang[] 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 (DefaultLang c : DefaultLang.values())
    System.out.println(c);

Returns:

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

valueOf

public static DefaultLang 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

getFormat

public Lang getFormat()

Description copied from interface: Lang

Returns the format specifier for this Lang file. This should be a constant in the enum and represent a value that is used for all messages universally.

Specified by:

getFormat in interface Lang

Returns:

The format specifier for this Lang

getPath

public String getPath()

Description copied from interface: PluginFile

The FileDataType path to store this value in

Specified by:

getPath in interface PluginFile

Returns:

The path to the file value

getDefault

public String getDefault()

Description copied from interface: Lang

The default value of this Lang string

Specified by:

getDefault in interface Lang

Specified by:

getDefault in interface PluginFile

Returns:

The default value

getData

public DataHolder<Yaml> getData()

Description copied from interface: PluginFile

Returns the relevant DataHolder for this file, which provides thread-safety for the FileDataType object initialization

Specified by:

getData in interface PluginFile

Returns:

The DataHolder for this PluginFile