org.datanucleus.util
Class Localiser

java.lang.Object
  org.datanucleus.util.Localiser

public class Localiser
extends Object

Resource Bundle manager, providing simplified means of using MessageFormat to localise the system.

Method Summary

static Localiser	getInstance(String bundle_name, ClassLoader class_loader) Accessor for a helper instance for a bundle.
String	msg(boolean includeCode, String messageKey) Message formatter for an internationalised message.
String	msg(boolean includeCode, String messageKey, long arg) Message formatter with one argument passed in that will be embedded in an internationalised message.
String	msg(boolean includeCode, String messageKey, Object arg1) Message formatter with one argument passed in that will be embedded in an internationalised message.
String	msg(boolean includeCode, String messageKey, Object arg1, Object arg2) Message formatter with a series of arguments passed in that will be embedded in an internationalised message.
String	msg(boolean includeCode, String messageKey, Object arg1, Object arg2, Object arg3) Message formatter with a series of arguments passed in that will be embedded in an internationalised message.
String	msg(boolean includeCode, String messageKey, Object arg1, Object arg2, Object arg3, Object arg4) Message formatter with a series of arguments passed in that will be embedded in an internationalised message.
String	msg(boolean includeCode, String messageKey, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5) Message formatter with a series of arguments passed in that will be embedded in an internationalised message.
String	msg(String messageKey) Message formatter for an internationalised message.
String	msg(String messageKey, long arg) Message formatter with one argument passed in that will be embedded in an internationalised message.
String	msg(String messageKey, Object arg1) Message formatter with one argument passed in that will be embedded in an internationalised message.
String	msg(String messageKey, Object arg1, Object arg2) Message formatter with a series of arguments passed in that will be embedded in an internationalised message.
String	msg(String messageKey, Object arg1, Object arg2, Object arg3) Message formatter with a series of arguments passed in that will be embedded in an internationalised message.
String	msg(String messageKey, Object arg1, Object arg2, Object arg3, Object arg4) Message formatter with a series of arguments passed in that will be embedded in an internationalised message.
String	msg(String messageKey, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5) Message formatter with a series of arguments passed in that will be embedded in an internationalised message.
static void	setDisplayCodesInMessages(boolean display) Method to allow turning on/off of display of error codes in messages.
static void	setLanguage(String languageCode) Convenience method to change the language of the resource bundles used by the localisers.

Methods inherited from class java.lang.Object

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

Method Detail

setLanguage

public static void setLanguage(String languageCode)

Convenience method to change the language of the resource bundles used by the localisers.

Parameters:

languageCode - The new language code

setDisplayCodesInMessages

public static void setDisplayCodesInMessages(boolean display)

Method to allow turning on/off of display of error codes in messages.

Parameters:

display - Whether to display codes

getInstance

public static Localiser getInstance(String bundle_name,
                                    ClassLoader class_loader)

Accessor for a helper instance for a bundle.

Parameters:

bundle_name - the name of the bundle

class_loader - the class loader from which to load the resource bundle

Returns:

the helper instance bound to the bundle

msg

public String msg(boolean includeCode,
                  String messageKey)

Message formatter for an internationalised message.

Parameters:

includeCode - Whether to include the code in the message

messageKey - the message key

Returns:

the resolved message text

msg

public String msg(boolean includeCode,
                  String messageKey,
                  long arg)

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

Parameters:

includeCode - Whether to include the code in the message

messageKey - the message key

arg - the argument

Returns:

the resolved message text

msg

public String msg(boolean includeCode,
                  String messageKey,
                  Object arg1)

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

Parameters:

includeCode - Whether to include the code in the message

messageKey - the message key

arg1 - the first argument

Returns:

the resolved message text

msg

public String msg(boolean includeCode,
                  String messageKey,
                  Object arg1,
                  Object arg2)

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

Parameters:

includeCode - Whether to include the code in the message

messageKey - the message key

arg1 - the first argument

arg2 - the second argument

Returns:

the resolved message text

msg

public String msg(boolean includeCode,
                  String messageKey,
                  Object arg1,
                  Object arg2,
                  Object arg3)

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

Parameters:

includeCode - Whether to include the code in the message

messageKey - the message key

arg1 - the first argument

arg2 - the second argument

arg3 - the third argument

Returns:

the resolved message text

msg

public String msg(boolean includeCode,
                  String messageKey,
                  Object arg1,
                  Object arg2,
                  Object arg3,
                  Object arg4)

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

Parameters:

includeCode - Whether to include the code in the message

messageKey - the message key

arg1 - the first argument

arg2 - the second argument

arg3 - the third argument

arg4 - the third argument

Returns:

the resolved message text

msg

public String msg(boolean includeCode,
                  String messageKey,
                  Object arg1,
                  Object arg2,
                  Object arg3,
                  Object arg4,
                  Object arg5)

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

Parameters:

includeCode - Whether to include the code in the message

messageKey - the message key

arg1 - the first argument

arg2 - the second argument

arg3 - the third argument

arg4 - the third argument

arg5 - the third argument

Returns:

the resolved message text

msg

public String msg(String messageKey)

Message formatter for an internationalised message.

Parameters:

messageKey - the message key

Returns:

the resolved message text

msg

public String msg(String messageKey,
                  Object arg1)

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

Parameters:

messageKey - the message key

arg1 - the first argument

Returns:

the resolved message text

msg

public String msg(String messageKey,
                  Object arg1,
                  Object arg2)

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

Parameters:

messageKey - the message key

arg1 - the first argument

arg2 - the second argument

Returns:

the resolved message text

msg

public String msg(String messageKey,
                  Object arg1,
                  Object arg2,
                  Object arg3)

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

Parameters:

messageKey - the message key

arg1 - the first argument

arg2 - the second argument

arg3 - the third argument

Returns:

the resolved message text

msg

public String msg(String messageKey,
                  Object arg1,
                  Object arg2,
                  Object arg3,
                  Object arg4)

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

Parameters:

messageKey - the message key

arg1 - the first argument

arg2 - the second argument

arg3 - the third argument

arg4 - the third argument

Returns:

the resolved message text

msg

public String msg(String messageKey,
                  Object arg1,
                  Object arg2,
                  Object arg3,
                  Object arg4,
                  Object arg5)

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

Parameters:

messageKey - the message key

arg1 - the first argument

arg2 - the second argument

arg3 - the third argument

arg4 - the third argument

arg5 - the third argument

Returns:

the resolved message text

msg

public 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 argument

Returns:

the resolved message text