com.codelanx.codelanxlib.config

Interface Lang

All Superinterfaces:

PluginFile

All Known Implementing Classes:

DefaultLang, InternalLang

public interface Lang
extends PluginFile

Represents a single value that is dynamically retrieved from a FileDataType. This value should be usable with a Formatter and is typically implemented through an enum

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
static String	color(String color) Automatically translates strings that contain color codes using the '&' symbol
static Lang	createLang(String format) Returns a raw Lang object that can be used for dynamic creation of Lang variables
static Lang	defaultFormat(String option) Returns a Lang object representing the default formatting for all CodelanxLib plugins.
default String	format(Object... args) Formats a Lang enum constant with the supplied arguments
default String	formatAndColor(Object... args) Formats a Lang enum constant with the supplied arguments, and colors it
default String	get() Returns the string value used for this Lang.
String	getDefault() The default value of this Lang string
Lang	getFormat() Returns the format specifier for this Lang file.
static Lang	getFormat(Plugin plugin) Returns an acceptable message format for the plugin at hand
default String	pluralFormat(int amount, Object... args) Will format a string with "PLURAL" or "PLURALA" tokens in them.
static String	proper(String raw) Formats a string into either a proper word or sentence (First letter capitalized, if spaces are included a period is added)
static String	proper(String raw, char punctuation) Formats a string into either a proper word or sentence (First letter capitalized, if spaces are included the supplied punctuation is added)
static void	sendMessage(CommandSender target, Lang format, Lang message, Object... args) Sends a message but does not include getFormat(), instead it uses a supplied format
static void	sendMessage(CommandSender target, Lang message, Object... args) Sends a formatted string and prepends the getFormat() to it.
static void	sendMessage(OfflinePlayer target, Lang format, Lang message, Object... args)
static void	sendMessage(OfflinePlayer target, Lang message, Object... args)
static void	sendMessage(Player target, Lang format, Lang message, Object... args)
static void	sendMessage(Player target, Lang message, Object... args)
static void	sendRawMessage(CommandSender target, Lang message, Object... args) Sends a raw message without additional formatting aside from translating color codes
static void	sendRawMessage(OfflinePlayer target, Lang message, Object... args)
static void	sendRawMessage(Player target, Lang message, Object... args)
static void	sendTitle(Player target, Lang message, Object... args) Issues a "title" command to a Player target with the passed Lang
static void	tellRaw(Player target, Lang message, Object... args) Issues a "tellRaw" to a Player target with the supplied Lang

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

getConfig, getData, getFileLocation, getPath, init, save, save

Method Detail

getFormat

Lang getFormat()

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.

Returns:

The format specifier for this Lang

Since:

0.1.0

getDefault

String getDefault()

The default value of this Lang string

Specified by:

getDefault in interface PluginFile

Returns:

The default value

Since:

0.1.0

get

default String get()

Returns the string value used for this Lang. Color codes will not be automatically converted

Specified by:

get in interface PluginFile

Returns:

The formatting string to be used for sending a message

Since:

0.1.0

formatAndColor

default String formatAndColor(Object... args)

Formats a Lang enum constant with the supplied arguments, and colors it

Parameters:

args - The arguments to supply

Returns:

The formatted string

Since:

0.1.0

format

default String format(Object... args)

Formats a Lang enum constant with the supplied arguments

Parameters:

args - The arguments to supply

Returns:

The formatted string

Since:

0.1.0

pluralFormat

default String pluralFormat(int amount,
                            Object... args)

Will format a string with "PLURAL" or "PLURALA" tokens in them.

• PLURALA: Token that will evaluate gramatically. An int value of 1 will return "is <amount> 'word'", otherwise it will be "are <amount> 'word'".
• PLURAL: Token that will evaluate the word. An int value of 1 will return the first word, value of 2 the second word.

Parameters:

amount - The amount representative of the data token

args - The arguments to replace any other tokens with.

Returns:

The formatting string value for plurals

Since:

0.1.0

createLang

static Lang createLang(String format)

Returns a raw Lang object that can be used for dynamic creation of Lang variables

Parameters:

format - The string to wrap in a Lang object

Returns:

A Lang object that will

Since:

0.1.0

defaultFormat

static Lang defaultFormat(String option)

Returns a Lang object representing the default formatting for all CodelanxLib plugins. The option parameter can be supplemented with null which will default to "CL-Lib". The returned format is:

"&f[&9" + option == null ? "CL-Lib" : option + "&f] %amp;s"

Parameters:

option - The optional "title" string for the format

Returns:

A Lang object representing the default format

Since:

0.1.0

getFormat

static Lang getFormat(Plugin plugin)

Returns an acceptable message format for the plugin at hand

Parameters:

plugin - A Plugin that needs a format

Returns:

A relevant Lang format

Since:

0.1.0

color

static String color(String color)

Automatically translates strings that contain color codes using the '&' symbol

Parameters:

color - String with un-converted color codes

Returns:

string with correct chat colors included

Since:

0.1.0

sendMessage

static void sendMessage(CommandSender target,
                        Lang message,
                        Object... args)

Sends a formatted string and prepends the getFormat() to it.

Parameters:

target - The target to send to

message - The message to colorize and send

args - Arguments to supply to the Lang message

Since:

0.1.0

sendMessage

static void sendMessage(CommandSender target,
                        Lang format,
                        Lang message,
                        Object... args)

Sends a message but does not include getFormat(), instead it uses a supplied format

Parameters:

target - The target to send to

format - The format provided

message - The message to colorize and send

args - Arguments to supply to the Lang message

Since:

0.1.0

sendRawMessage

static void sendRawMessage(CommandSender target,
                           Lang message,
                           Object... args)

Sends a raw message without additional formatting aside from translating color codes

Parameters:

target - The target to send to

message - The message to colorize and send

args - Arguments to supply to the Lang message

Since:

0.1.0

tellRaw

static void tellRaw(Player target,
                    Lang message,
                    Object... args)

Issues a "tellRaw" to a Player target with the supplied Lang

Parameters:

target - The Player to send the JSON message to

message - A Lang representing a JSON payload

args - The arguments for the passed Lang

Since:

0.1.0

sendTitle

static void sendTitle(Player target,
                      Lang message,
                      Object... args)

Issues a "title" command to a Player target with the passed Lang

Parameters:

target - The Player to send the JSON title to

message - A Lang representing a JSON payload for the title

args - The arguments for the passed Lang

Since:

0.1.0

proper

static String proper(String raw)

Formats a string into either a proper word or sentence (First letter capitalized, if spaces are included a period is added)

Parameters:

raw - The raw string to format

Returns:

The formatted string

Since:

0.1.0

See Also:

proper(String, char)

proper

static String proper(String raw,
                     char punctuation)

Formats a string into either a proper word or sentence (First letter capitalized, if spaces are included the supplied punctuation is added)

Parameters:

raw - The raw string to format

punctuation - Punctuation to append to anything containing spaces

Returns:

The formatted string

Since:

0.1.0

sendMessage

static void sendMessage(OfflinePlayer target,
                        Lang format,
                        Lang message,
                        Object... args)

sendMessage

static void sendMessage(OfflinePlayer target,
                        Lang message,
                        Object... args)

sendRawMessage

static void sendRawMessage(OfflinePlayer target,
                           Lang message,
                           Object... args)

sendMessage

static void sendMessage(Player target,
                        Lang format,
                        Lang message,
                        Object... args)

sendMessage

static void sendMessage(Player target,
                        Lang message,
                        Object... args)

sendRawMessage

static void sendRawMessage(Player target,
                           Lang message,
                           Object... args)