Localiser (DataNucleus Core 3.2.15 API)

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.
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 default locale (English), but can be extended easily by adding localisationfiles in languages such as Spanish, French, etc. The internationalisation operates around the org.datanucleus.util.Localiser class that is responsible for generating the messages in the specified locale. Each class needs to instantiate a Localiser private static final Localiser LOCALISER=Localiser.getInstance("org.datanucleus.store.Localisation", MyClass.class); and then output messages via LOCALISER.msg("012345", schemaName, autoStartMechanism) The messages themselves are contained in a file for each package. For example, with the above example, we have org.datanucleus.store.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. The language-specific parts are always contained in the Localisation.properties file. To extend the current system to internationalise in, for example, Spanish you would add a file org.datanucleus.store.Localisation_es.properties and add an entry such as 012345=Inicializando la esquema "{0}" con la opción de empezar "{1}" With this file installed, anybody running an application where the JDK is running in Spanish as default locale would see the above Spanish message. It is intended to include such files in a future release.

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.

Note that the second argument used in constructing the Localiser is important for OSGi. It has to be a class in the same OSGi bundle as the Localisation.properties file

You will find alternates in Spanish already present named "Localisation_es.properties", so if you wanted to create a French localisation then provide "Localisation_fr.properties".

Method Summary

Methods
Modifier and Type	Method and Description
`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

Class Localiser

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setLanguage

setDisplayCodesInMessages

getInstance

msg

msg

msg

msg

msg

msg

msg

msg

msg

msg

msg

msg

msg

msg