org.datanucleus.util

Class Localiser

java.lang.Object

org.datanucleus.util.Localiser

public class Localiser
extends Object

Localiser for messages in the DataNucleus system. Provides access to a singleton, via the

getInstance

method. Any plugin that provides its own resources via a properties file should call

Localiser.registerBundle(...)

before the resources are required to be used.

The DataNucleus system is internationalisable hence messages (to log files or exceptions) can be displayed in multiple languages. Currently DataNucleus contains localisation files in the English and Spanish, but can be extended easily by adding localisation files in languages such as French, etc. The internationalisation operates around a Java ResourceBundle, loading a properties file. Messages are output via calling

Localiser.msg("012345", args);

The messages themselves are contained in a file for each package. For example, with the above example, we have "org.datanucleus.Localisation.properties". This contains entries such as

012345=Initialising Schema "{0}" using "{1}" auto-start option

So the 2 parameters specified in the

Localiser.msg(...)

call are inserted into the message.

Extending for other languages

The language-specific parts are always contained in the Localisation.properties file. To extend the current system to internationalise in, for example, French you would add a file "org.datanucleus.Localisation_fr.properties" and add entries with the required French text. If you want to extend this to another language and contribute the files for your language you need to find all files "Localisation.properties" and provide an alternative variant, raise an issue, and attach your patch to the issue.

Constructor Summary

Constructors

Constructor and Description
Localiser()

Method Summary

Modifier and Type	Method and Description
static String	msg(String messageKey) Message formatter for an internationalised message.
static String	msg(String messageKey, long arg) Message formatter with one argument passed in that will be embedded in an internationalised message.
static String	msg(String messageKey, Object... args) Message formatter with arguments passed in that will be embedded in an internationalised message.
static void	registerBundle(String bundleName, ClassLoader loader) Method to be called by plugins that have their own ResourceBundle, so the messages will be registered and available for use.

Methods inherited from class java.lang.Object

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

Constructor Detail

Localiser

public Localiser()

Method Detail

registerBundle

public static void registerBundle(String bundleName,
                                  ClassLoader loader)

Method to be called by plugins that have their own ResourceBundle, so the messages will be registered and available for use.

Parameters:

bundleName - Name of the bundle e.g "org.datanucleus.store.myplugin.Localisation"

loader - Loader for the bundle

msg

public static String msg(String messageKey)

Message formatter for an internationalised message.

Parameters:

messageKey - the message key

Returns:

the resolved message text

msg

public static String msg(String messageKey,
                         long arg)

Message formatter with one argument passed in that will be embedded in an internationalised message.

Parameters:

messageKey - the message key

arg - the long argument

Returns:

the resolved message text

msg

public static String msg(String messageKey,
                         Object... args)

Message formatter with arguments passed in that will be embedded in an internationalised message.

Parameters:

messageKey - the message key

args - the arguments

Returns:

the resolved message text