com.codelanx.codelanxlib.internal

Enum InternalLang

java.lang.Object

java.lang.Enum<InternalLang>

com.codelanx.codelanxlib.internal.InternalLang

All Implemented Interfaces:

Lang, PluginFile, Serializable, Comparable<InternalLang>

public enum InternalLang
extends Enum<InternalLang>
implements Lang

Internal Lang enum for CodelanxLib

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMAND_HELP_INFO Help information for HelpCommand
COMMAND_HELP_ITEMFORMAT Format for listing a command in HelpCommand
COMMAND_HELP_TITLEFORMAT Title for the HelpCommand's internal Paginator
COMMAND_RELOAD_DONE Output of a finished ReloadCommand
COMMAND_RELOAD_INFO Info for ReloadCommand
COMMAND_RELOAD_UNSUPPORTED Relayed if reloading is not supported
COMMAND_STATUS_FAILED Relayed when a command execution fail (exceptions or the like)
COMMAND_STATUS_NOPERM Relayed if a CommandSender does not have permissions to use the command
COMMAND_STATUS_RESTRICTED Relayed when an inappropriate CommandSender is used for a command
COMMAND_STATUS_UNSUPPORTED Relayed upon an unknown/unsupported command
COMMAND_STATUS_USAGE Used to relay the usage of a command
ECONOMY_FAILED Relayed if an economy transaction failed
ECONOMY_INSUFF Relayed if funds for an economy transaction are insufficient
ECONOMY_REFUND Relayed if a player is refunded money
FORMAT Format for CodelanxLib
PAGINATOR_BARCHAR Character to use for the Paginator bars
PAGINATOR_BARCOLOR Bar color for the Paginator class
PAGINATOR_PAGEFORMAT The format specified for displaying page count
PAGINATOR_TITLECOLOR Color of the title for the Paginator class
PAGINATOR_TITLECONTAINER Accept a bar color first, title color second, then the title itself third

Method Summary

Modifier and Type	Method and Description
Yaml	getConfig() Returns the relevant FileDataType for this config.
String	getDefault() The default value of this YAML string
Lang	getFormat() Returns the format specifier for this Lang file.
String	getPath() The YAML path to store this value in
static InternalLang	valueOf(String name) Returns the enum constant of this type with the specified name.
static InternalLang[]	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, getFormat, pluralFormat, sendMessage, sendMessage, sendRawMessage

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

getFileLocation, init, save, save

Enum Constant Detail

COMMAND_STATUS_USAGE

public static final InternalLang COMMAND_STATUS_USAGE

Used to relay the usage of a command

COMMAND_STATUS_NOPERM

public static final InternalLang COMMAND_STATUS_NOPERM

Relayed if a CommandSender does not have permissions to use the command

COMMAND_STATUS_FAILED

public static final InternalLang COMMAND_STATUS_FAILED

Relayed when a command execution fail (exceptions or the like)

COMMAND_STATUS_UNSUPPORTED

public static final InternalLang COMMAND_STATUS_UNSUPPORTED

Relayed upon an unknown/unsupported command

COMMAND_STATUS_RESTRICTED

public static final InternalLang COMMAND_STATUS_RESTRICTED

Relayed when an inappropriate CommandSender is used for a command

COMMAND_HELP_TITLEFORMAT

public static final InternalLang COMMAND_HELP_TITLEFORMAT

Title for the HelpCommand's internal Paginator

COMMAND_HELP_ITEMFORMAT

public static final InternalLang COMMAND_HELP_ITEMFORMAT

Format for listing a command in HelpCommand

COMMAND_HELP_INFO

public static final InternalLang COMMAND_HELP_INFO

Help information for HelpCommand

COMMAND_RELOAD_UNSUPPORTED

public static final InternalLang COMMAND_RELOAD_UNSUPPORTED

Relayed if reloading is not supported

COMMAND_RELOAD_DONE

public static final InternalLang COMMAND_RELOAD_DONE

Output of a finished ReloadCommand

COMMAND_RELOAD_INFO

public static final InternalLang COMMAND_RELOAD_INFO

Info for ReloadCommand

ECONOMY_INSUFF

public static final InternalLang ECONOMY_INSUFF

Relayed if funds for an economy transaction are insufficient

ECONOMY_REFUND

public static final InternalLang ECONOMY_REFUND

Relayed if a player is refunded money

ECONOMY_FAILED

public static final InternalLang ECONOMY_FAILED

Relayed if an economy transaction failed

PAGINATOR_BARCHAR

public static final InternalLang PAGINATOR_BARCHAR

Character to use for the Paginator bars

PAGINATOR_BARCOLOR

public static final InternalLang PAGINATOR_BARCOLOR

Bar color for the Paginator class

PAGINATOR_TITLECOLOR

public static final InternalLang PAGINATOR_TITLECOLOR

Color of the title for the Paginator class

PAGINATOR_TITLECONTAINER

public static final InternalLang PAGINATOR_TITLECONTAINER

Accept a bar color first, title color second, then the title itself third

PAGINATOR_PAGEFORMAT

public static final InternalLang PAGINATOR_PAGEFORMAT

The format specified for displaying page count

FORMAT

public static final InternalLang FORMAT

Format for CodelanxLib

Method Detail

values

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

Returns:

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

valueOf

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

getPath

public String getPath()

Description copied from interface: PluginFile

The YAML 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 YAML string

Specified by:

getDefault in interface Lang

Specified by:

getDefault in interface PluginFile

Returns:

The default value

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

getConfig

public Yaml getConfig()

Description copied from interface: PluginFile

Returns the relevant FileDataType for this config.

Specified by:

getConfig in interface PluginFile

Returns:

The internal FileDataType of this Config