net.amigocraft.mglib.impl

Class BukkitLocale

java.lang.Object

net.amigocraft.mglib.api.Locale

net.amigocraft.mglib.impl.BukkitLocale

public class BukkitLocale
extends Locale

Constructor Summary

Constructors

Constructor and Description
BukkitLocale(java.lang.String plugin) Creates a new locale manager for the given plugin.

Method Summary

Modifier and Type	Method and Description
java.lang.String	_INVALID_getMessage(java.lang.String key) Retrieves the message with the given key from the current locale.
java.lang.String	_INVALID_getMessage(java.lang.String key, java.lang.String... replacements) Retrieves the message with the given key from the current locale, and replaces placeholder sequences (%i) with the corresponding vararg parameter.
boolean	equals(java.lang.Object otherLocale)
Localizable	getMessage(java.lang.String key, java.lang.Object... replacements) Retrieves the message with the given key from the current locale, and replaces placeholder sequences (%i) with the corresponding vararg parameter.
java.lang.String	getPlugin() Returns the name of the plugin which this Locale belongs to.
int	hashCode()
boolean	isLegacy() Returns whether this object was loaded from a legacy locale file.

Methods inherited from class net.amigocraft.mglib.api.Locale

initialize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BukkitLocale

public BukkitLocale(java.lang.String plugin)

Creates a new locale manager for the given plugin.

MGLib attempts to load locales first from the "locales" directory in the plugin's data folder, then from the locales directory in the plugin JAR's root.

Parameters:

plugin - the plugin to create a locale manager for

Method Detail

getPlugin

public java.lang.String getPlugin()

Description copied from class: Locale

Returns the name of the plugin which this Locale belongs to.

Specified by:

getPlugin in class Locale

Returns:

the name of the plugin which this Locale belongs to

_INVALID_getMessage

public java.lang.String _INVALID_getMessage(java.lang.String key)

Description copied from class: Locale

Retrieves the message with the given key from the current locale.

This method is included for the sake of reverse-compatibility. It will not exist at runtime and thus should not be used under any circumstances.

Specified by:

_INVALID_getMessage in class Locale

Parameters:

key - the key of the message to retrieve

Returns:

the message associated with the given key, or the key if the message is not defined

_INVALID_getMessage

public java.lang.String _INVALID_getMessage(java.lang.String key,
                                            java.lang.String... replacements)

Description copied from class: Locale

Retrieves the message with the given key from the current locale, and replaces placeholder sequences (%i) with the corresponding vararg parameter.

This method is included for the sake of reverse-compatibility. It will not exist at runtime and thus should not be used under any circumstances.

Specified by:

_INVALID_getMessage in class Locale

Parameters:

key - the key of the message to retrieve

replacements - an array or vararg list of strings to replace placeholder sequences (%i) with

Returns:

the message associated with the given key, or the key if the message is not defined

getMessage

public Localizable getMessage(java.lang.String key,
                              java.lang.Object... replacements)

Description copied from class: Locale

Retrieves the message with the given key from the current locale, and replaces placeholder sequences (%i) with the corresponding vararg parameter. This method will never return null.

Note: placeholder sequences should start at index 1.

Specified by:

getMessage in class Locale

Parameters:

key - the key of the message to retrieve

replacements - an array or vararg list of objects to replace placeholder sequences (%i) with. If an object in this list is an instance of a Localizable, it will be localized appropriately. Otherwise, toString() will be invoked upon it.

Returns:

the Localizable associated with the given key

isLegacy

public boolean isLegacy()

Description copied from class: Locale

Returns whether this object was loaded from a legacy locale file.

Specified by:

isLegacy in class Locale

Returns:

whether this object was loaded from a legacy locale file.

equals

public boolean equals(java.lang.Object otherLocale)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object