Enum Class InternalMessages

java.lang.Object

java.lang.Enum<InternalMessages>

dev.ua.theroer.magicutils.lang.InternalMessages

All Implemented Interfaces:

Serializable, Comparable<InternalMessages>, Constable

public enum InternalMessages
extends Enum<InternalMessages>

Internal messages keys for MagicUtils library (platform-agnostic).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CMD_EXECUTED	Command executed successfully.
CMD_EXECUTION_ERROR	Generic execution failure.
CMD_HELP_ALIASES_INLINE	Help inline aliases text.
CMD_HELP_ARGUMENT_PERMISSION	Help-generated argument permission description.
CMD_HELP_AVAILABLE_COMMANDS	Help available commands section label.
CMD_HELP_COMMAND_DESCRIPTION	Built-in help command description.
CMD_HELP_COMMAND_NOT_FOUND	Help target command not found.
CMD_HELP_DEFAULT_VALUE	Help default value marker.
CMD_HELP_HOVER_SHOW	Help hover text for clickable entries.
CMD_HELP_LABEL_ALIASES	Help aliases label.
CMD_HELP_LABEL_ARGUMENTS	Help arguments label.
CMD_HELP_LABEL_COMMAND	Help command label.
CMD_HELP_LABEL_DESCRIPTION	Help description label.
CMD_HELP_LABEL_SUBCOMMANDS	Help subcommands label.
CMD_HELP_NAV_NEXT	Help next page hover.
CMD_HELP_NAV_PREVIOUS	Help previous page hover.
CMD_HELP_NO_COMMANDS_FOUND	Help empty state when nothing matches.
CMD_HELP_NO_DESCRIPTION	Help fallback description.
CMD_HELP_OPTIONAL	Help optional argument marker.
CMD_HELP_PAGE_LABEL	Help page label.
CMD_HELP_QUERY_PREFIX	Help search query prefix.
CMD_HELP_SENDER_UNAVAILABLE	Help command sender missing.
CMD_HELP_SUBCOMMAND_DESCRIPTION	Built-in help subcommand description.
CMD_HELP_TITLE	Help header title.
CMD_HELP_UNAVAILABLE	Help is unavailable because no manager is ready.
CMD_HELP_USAGE_OR	Help usage separator between direct and subcommand forms.
CMD_HELP_VALUES	Help values marker.
CMD_INTERNAL_ERROR	Internal error while running command.
CMD_INVALID_ARGUMENTS	Invalid arguments supplied.
CMD_NO_PERMISSION	Lacking permission to run command.
CMD_NOT_FOUND	Command not found.
CMD_SPECIFY_SUBCOMMAND	Prompt to specify subcommand.
CMD_UNKNOWN_SUBCOMMAND	Unknown subcommand provided.
ERR_COMMANDMAP_NOT_AVAILABLE	CommandMap unavailable.
ERR_FAILED_GET_COMMANDMAP	Failed to obtain CommandMap.
ERR_MESSAGE_NOT_SET	Message must be set before sending.
ERR_MISSING_COMMANDINFO	Missing @CommandInfo annotation.
ERR_MISSING_CONFIGFILE	Missing @ConfigFile annotation.
ERR_REGISTRY_NOT_INITIALIZED	Command registry not initialised.
ERR_REQUIRED_CONFIG_MISSING	Required config value absent.
RELOAD_ALL_COMMANDS	All commands reloaded.
RELOAD_ALL_SECTIONS	All sections reloaded.
RELOAD_COMMAND	Single command reloaded.
RELOAD_GLOBAL_SETTING	Single global setting reloaded.
RELOAD_GLOBAL_SETTINGS	All global settings reloaded.
RELOAD_SECTION	Single section reloaded.
SETTINGS_AVAILABLE_LANGS	Available languages list.
SETTINGS_CURRENT_LANG	Current language value.
SETTINGS_INVALID_ARGS	Settings command received invalid args.
SETTINGS_KEY_NOT_FOUND	Requested key missing.
SETTINGS_KEY_SET	Key set confirmation.
SETTINGS_KEY_VALUE	Value of a specific key.
SETTINGS_LANG_NOT_FOUND	Requested language missing.
SETTINGS_LANG_NOT_INIT	Language manager not initialised.
SYS_ALIAS_REGISTERED	Alias registered.
SYS_ALIAS_USAGE	Alias usage line.
SYS_COMMAND_REGISTERED	Command registered.
SYS_COMMAND_USAGE	Command usage line.
SYS_CREATED_DEFAULT_CONFIG	Created default config file.
SYS_FAILED_LOAD_LANGUAGE	Failed to load language file.
SYS_FAILED_SAVE_MESSAGES	Failed to save custom messages.
SYS_GENERATED_PERMISSIONS	Generated permissions notice.
SYS_LOADED_LANGUAGE	Language file loaded.
SYS_SECTION_NOT_RELOADABLE	Section cannot be reloaded.
SYS_SUBCOMMAND_USAGES	Subcommand usage list.
SYS_UNREGISTERED_COMMAND	Command unregistered.

Method Summary

Modifier and Type	Method	Description
String	get()	Get localized value or default.
String	get(String... replacements)	Get localized value with replacements or default.
String	getKey()	Fully qualified message key (magicutils.*).
String	getScoped(String scope, Audience audience)	Get localized value for an audience using a scoped language manager with fallback to the global manager.
String	getScoped(String scope, Audience audience, String... replacements)	Get localized value with replacements for an audience using a scoped language manager with fallback to the global manager.
String	getScoped(String scope, String... replacements)	Get localized value using a scoped language manager with fallback to the global manager.
static InternalMessages	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InternalMessages[]	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

CMD_NO_PERMISSION

public static final InternalMessages CMD_NO_PERMISSION

Lacking permission to run command.

CMD_EXECUTION_ERROR

public static final InternalMessages CMD_EXECUTION_ERROR

Generic execution failure.

CMD_EXECUTED

public static final InternalMessages CMD_EXECUTED

Command executed successfully.

CMD_SPECIFY_SUBCOMMAND

public static final InternalMessages CMD_SPECIFY_SUBCOMMAND

Prompt to specify subcommand.

CMD_UNKNOWN_SUBCOMMAND

public static final InternalMessages CMD_UNKNOWN_SUBCOMMAND

Unknown subcommand provided.

CMD_INVALID_ARGUMENTS

public static final InternalMessages CMD_INVALID_ARGUMENTS

Invalid arguments supplied.

CMD_NOT_FOUND

public static final InternalMessages CMD_NOT_FOUND

Command not found.

CMD_INTERNAL_ERROR

public static final InternalMessages CMD_INTERNAL_ERROR

Internal error while running command.

CMD_HELP_COMMAND_DESCRIPTION

public static final InternalMessages CMD_HELP_COMMAND_DESCRIPTION

Built-in help command description.

CMD_HELP_SUBCOMMAND_DESCRIPTION

public static final InternalMessages CMD_HELP_SUBCOMMAND_DESCRIPTION

Built-in help subcommand description.

CMD_HELP_SENDER_UNAVAILABLE

public static final InternalMessages CMD_HELP_SENDER_UNAVAILABLE

Help command sender missing.

CMD_HELP_UNAVAILABLE

public static final InternalMessages CMD_HELP_UNAVAILABLE

Help is unavailable because no manager is ready.

CMD_HELP_COMMAND_NOT_FOUND

public static final InternalMessages CMD_HELP_COMMAND_NOT_FOUND

Help target command not found.

CMD_HELP_TITLE

public static final InternalMessages CMD_HELP_TITLE

Help header title.

CMD_HELP_AVAILABLE_COMMANDS

public static final InternalMessages CMD_HELP_AVAILABLE_COMMANDS

Help available commands section label.

CMD_HELP_NO_COMMANDS_FOUND

public static final InternalMessages CMD_HELP_NO_COMMANDS_FOUND

Help empty state when nothing matches.

CMD_HELP_LABEL_COMMAND

public static final InternalMessages CMD_HELP_LABEL_COMMAND

Help command label.

CMD_HELP_LABEL_DESCRIPTION

public static final InternalMessages CMD_HELP_LABEL_DESCRIPTION

Help description label.

CMD_HELP_LABEL_ALIASES

public static final InternalMessages CMD_HELP_LABEL_ALIASES

Help aliases label.

CMD_HELP_LABEL_SUBCOMMANDS

public static final InternalMessages CMD_HELP_LABEL_SUBCOMMANDS

Help subcommands label.

CMD_HELP_LABEL_ARGUMENTS

public static final InternalMessages CMD_HELP_LABEL_ARGUMENTS

Help arguments label.

CMD_HELP_OPTIONAL

public static final InternalMessages CMD_HELP_OPTIONAL

Help optional argument marker.

CMD_HELP_DEFAULT_VALUE

public static final InternalMessages CMD_HELP_DEFAULT_VALUE

Help default value marker.

CMD_HELP_VALUES

public static final InternalMessages CMD_HELP_VALUES

Help values marker.

CMD_HELP_PAGE_LABEL

public static final InternalMessages CMD_HELP_PAGE_LABEL

Help page label.

CMD_HELP_NAV_PREVIOUS

public static final InternalMessages CMD_HELP_NAV_PREVIOUS

Help previous page hover.

CMD_HELP_NAV_NEXT

public static final InternalMessages CMD_HELP_NAV_NEXT

Help next page hover.

CMD_HELP_QUERY_PREFIX

public static final InternalMessages CMD_HELP_QUERY_PREFIX

Help search query prefix.

CMD_HELP_NO_DESCRIPTION

public static final InternalMessages CMD_HELP_NO_DESCRIPTION

Help fallback description.

CMD_HELP_HOVER_SHOW

public static final InternalMessages CMD_HELP_HOVER_SHOW

Help hover text for clickable entries.

CMD_HELP_ALIASES_INLINE

public static final InternalMessages CMD_HELP_ALIASES_INLINE

Help inline aliases text.

CMD_HELP_ARGUMENT_PERMISSION

public static final InternalMessages CMD_HELP_ARGUMENT_PERMISSION

Help-generated argument permission description.

CMD_HELP_USAGE_OR

public static final InternalMessages CMD_HELP_USAGE_OR

Help usage separator between direct and subcommand forms.

SETTINGS_LANG_NOT_INIT

public static final InternalMessages SETTINGS_LANG_NOT_INIT

Language manager not initialised.

SETTINGS_INVALID_ARGS

public static final InternalMessages SETTINGS_INVALID_ARGS

Settings command received invalid args.

SETTINGS_CURRENT_LANG

public static final InternalMessages SETTINGS_CURRENT_LANG

Current language value.

SETTINGS_AVAILABLE_LANGS

public static final InternalMessages SETTINGS_AVAILABLE_LANGS

Available languages list.

SETTINGS_LANG_NOT_FOUND

public static final InternalMessages SETTINGS_LANG_NOT_FOUND

Requested language missing.

SETTINGS_KEY_NOT_FOUND

public static final InternalMessages SETTINGS_KEY_NOT_FOUND

Requested key missing.

SETTINGS_KEY_VALUE

public static final InternalMessages SETTINGS_KEY_VALUE

Value of a specific key.

SETTINGS_KEY_SET

public static final InternalMessages SETTINGS_KEY_SET

Key set confirmation.

RELOAD_ALL_COMMANDS

public static final InternalMessages RELOAD_ALL_COMMANDS

All commands reloaded.

RELOAD_COMMAND

public static final InternalMessages RELOAD_COMMAND

Single command reloaded.

RELOAD_ALL_SECTIONS

public static final InternalMessages RELOAD_ALL_SECTIONS

All sections reloaded.

RELOAD_SECTION

public static final InternalMessages RELOAD_SECTION

Single section reloaded.

RELOAD_GLOBAL_SETTINGS

public static final InternalMessages RELOAD_GLOBAL_SETTINGS

All global settings reloaded.

RELOAD_GLOBAL_SETTING

public static final InternalMessages RELOAD_GLOBAL_SETTING

Single global setting reloaded.

SYS_LOADED_LANGUAGE

public static final InternalMessages SYS_LOADED_LANGUAGE

Language file loaded.

SYS_FAILED_LOAD_LANGUAGE

public static final InternalMessages SYS_FAILED_LOAD_LANGUAGE

Failed to load language file.

SYS_FAILED_SAVE_MESSAGES

public static final InternalMessages SYS_FAILED_SAVE_MESSAGES

Failed to save custom messages.

SYS_CREATED_DEFAULT_CONFIG

public static final InternalMessages SYS_CREATED_DEFAULT_CONFIG

Created default config file.

SYS_SECTION_NOT_RELOADABLE

public static final InternalMessages SYS_SECTION_NOT_RELOADABLE

Section cannot be reloaded.

SYS_COMMAND_REGISTERED

public static final InternalMessages SYS_COMMAND_REGISTERED

Command registered.

SYS_COMMAND_USAGE

public static final InternalMessages SYS_COMMAND_USAGE

Command usage line.

SYS_SUBCOMMAND_USAGES

public static final InternalMessages SYS_SUBCOMMAND_USAGES

Subcommand usage list.

SYS_ALIAS_REGISTERED

public static final InternalMessages SYS_ALIAS_REGISTERED

Alias registered.

SYS_ALIAS_USAGE

public static final InternalMessages SYS_ALIAS_USAGE

Alias usage line.

SYS_GENERATED_PERMISSIONS

public static final InternalMessages SYS_GENERATED_PERMISSIONS

Generated permissions notice.

SYS_UNREGISTERED_COMMAND

public static final InternalMessages SYS_UNREGISTERED_COMMAND

Command unregistered.

ERR_MESSAGE_NOT_SET

public static final InternalMessages ERR_MESSAGE_NOT_SET

Message must be set before sending.

ERR_FAILED_GET_COMMANDMAP

public static final InternalMessages ERR_FAILED_GET_COMMANDMAP

Failed to obtain CommandMap.

ERR_REGISTRY_NOT_INITIALIZED

public static final InternalMessages ERR_REGISTRY_NOT_INITIALIZED

Command registry not initialised.

ERR_COMMANDMAP_NOT_AVAILABLE

public static final InternalMessages ERR_COMMANDMAP_NOT_AVAILABLE

CommandMap unavailable.

ERR_MISSING_COMMANDINFO

public static final InternalMessages ERR_MISSING_COMMANDINFO

Missing @CommandInfo annotation.

ERR_MISSING_CONFIGFILE

public static final InternalMessages ERR_MISSING_CONFIGFILE

Missing @ConfigFile annotation.

ERR_REQUIRED_CONFIG_MISSING

public static final InternalMessages ERR_REQUIRED_CONFIG_MISSING

Required config value absent.

Method Details

values

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

getKey

public String getKey()

Fully qualified message key (magicutils.*).

Returns:

full translation key

get

public String get()

Get localized value or default.

Returns:

translated text or default message

get

public String get(String... replacements)

Get localized value with replacements or default.

Parameters:

replacements - placeholder/value pairs

Returns:

translated text with replacements or default message

getScoped

public String getScoped(String scope,
 String... replacements)

Get localized value using a scoped language manager with fallback to the global manager.

Parameters:

scope - scope identifier

replacements - placeholder/value pairs

Returns:

translated text with replacements or default message

getScoped

public String getScoped(String scope,
 Audience audience)

Get localized value for an audience using a scoped language manager with fallback to the global manager.

Parameters:

scope - scope identifier

audience - target audience

Returns:

translated text or default message

getScoped

public String getScoped(String scope,
 Audience audience,
 String... replacements)

Get localized value with replacements for an audience using a scoped language manager with fallback to the global manager.

Parameters:

scope - scope identifier

audience - target audience

replacements - placeholder/value pairs

Returns:

translated text with replacements or default message