fr.aumgn.bukkitutils.localization

Class Localization

java.lang.Object

fr.aumgn.bukkitutils.localization.Localization

Direct Known Subclasses:

CommandsLocalization

public class Localization
extends Object

Class which handles loading of localization resources for the given plugin and locale. This class looks for resources in the plugin's jarfile (in the plugin's package) and in the plugin's data folder. Resources are defined by a name to which is appended a suffix corresponding to the locale. For example if you're looking for a resource with the name "messages" for the plugin MyPlugin whose main class is "fr.aumgn.myplugin.MyPlugin" and the locale "fr_FR", the class will go through all this steps :

• Looks for the resource fr/aumgn/myplugin/messages_en.{json,yml,properties} in the jarfile
• Looks for the resource [server]/plugins/MyPlugin/messages_en.{json,yml,properties}
• Looks for the resource fr/aumgn/myplugin/messages_en_US.{json,yml,properties} in the jarfile
• Looks for the resource [server]/plugins/MyPlugin/messages_en_US.{json,yml,properties}
• Looks for the resource fr/aumgn/myplugin/messages_fr.{json,yml,properties} in the jarfile
• Looks for the resource [server]/plugins/MyPlugin/messages_fr.{json,yml,properties}
• Looks for the resource fr/aumgn/myplugin/messages_fr_FR.{json,yml,properties} in the jarfile
• Looks for the resource [server]/plugins/MyPlugin/messages_fr_FR.{json,yml,properties}

Each values find in a loaded resources has priority over values find in previous resources.

Field Summary

Fields

Modifier and Type	Field and Description
static Locale	DEFAULT_LOCALE
protected Locale[]	locales
protected JavaPlugin	plugin

Constructor Summary

Constructors

Constructor and Description
Localization(JavaPlugin plugin)
Localization(JavaPlugin plugin, File dir, Locale targetLocale)
Localization(JavaPlugin plugin, File dir, Locale targetLocale, Locale fallbackLocale)
Localization(JavaPlugin plugin, Locale targetLocale)
Localization(JavaPlugin plugin, Locale targetLocale, Locale fallbackLocale)

Method Summary

Methods

Modifier and Type	Method and Description
PluginMessages	get(String name) Loads the resources with the given name.
protected void	load(Map<String,MessageFormat> map, Locale locale, String name)
protected static Iterable<MessagesLoader>	loaders()
protected Map<String,MessageFormat>	loadMap(String name)
protected void	loadStream(Map<String,MessageFormat> map, Locale locale, MessagesLoader loader, InputStream iStream)
static Locale[]	localesLookupFor(Locale targetLocale, Locale fallbackLocale)
static void	register(MessagesLoader loader) Registers a MessagesLoader.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOCALE

public static final Locale DEFAULT_LOCALE

plugin

protected final JavaPlugin plugin

locales

protected final Locale[] locales

Constructor Detail

Localization

public Localization(JavaPlugin plugin)

Localization

public Localization(JavaPlugin plugin,
            Locale targetLocale)

Localization

public Localization(JavaPlugin plugin,
            Locale targetLocale,
            Locale fallbackLocale)

Localization

public Localization(JavaPlugin plugin,
            File dir,
            Locale targetLocale)

Localization

public Localization(JavaPlugin plugin,
            File dir,
            Locale targetLocale,
            Locale fallbackLocale)

Method Detail

register

public static void register(MessagesLoader loader)

Registers a MessagesLoader.

loaders

protected static Iterable<MessagesLoader> loaders()

localesLookupFor

public static Locale[] localesLookupFor(Locale targetLocale,
                        Locale fallbackLocale)

get

public PluginMessages get(String name)

Loads the resources with the given name.

loadMap

protected Map<String,MessageFormat> loadMap(String name)

load

protected void load(Map<String,MessageFormat> map,
        Locale locale,
        String name)

loadStream

protected void loadStream(Map<String,MessageFormat> map,
              Locale locale,
              MessagesLoader loader,
              InputStream iStream)