de.aristaflow.adept2.model.common.i18n

Class LocalisationTools

java.lang.Object

de.aristaflow.adept2.model.common.i18n.LocalisationTools

public final class LocalisationTools
extends java.lang.Object

Tool methods for localising log and check report messages. Unlike de.aristaflow.adept2.util.LocaleTools this also supports LocalisedStrings, that are localised string representations of variables from the calling context. For instance model elements like node or instance names will be localised in the message.

Constructor Summary

Constructors

Constructor and Description
LocalisationTools()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.util.Locale,java.lang.String>	fillLocalisedMessage(java.util.Map<java.util.Locale,java.lang.String> localisedMessage, java.lang.String msgKey, java.lang.String bundleName, java.util.List<java.util.Locale> locales, java.lang.Class<?> localisingClass, LocalisationFactory locFac, LocalisedString... args) Loads the designated message key from the designated bundle for the designated locales and stores them in the designated map.
static java.lang.String	getLocalisedMessage(java.lang.String msgKey, java.lang.String bundleName, java.util.Locale locale, java.lang.Class<?> localisingClass, LocalisationFactory locFac, LocalisedString... args) Gets the localised message for the designated message key from the designated bundle for the designated locale.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalisationTools

public LocalisationTools()

Method Detail

getLocalisedMessage

public static java.lang.String getLocalisedMessage(java.lang.String msgKey,
                                                   java.lang.String bundleName,
                                                   java.util.Locale locale,
                                                   java.lang.Class<?> localisingClass,
                                                   LocalisationFactory locFac,
                                                   LocalisedString... args)

Gets the localised message for the designated message key from the designated bundle for the designated locale. That is, a resource bundle with the designated name is loaded with the designated classloader for the designated locales. The designated localised strings will be resolved and merged with the message for the designated message key from the resource bundle. The resulting localised message is then returned. This may be a fallback locale for the requested locale.

Parameters:

msgKey - The message key with which to retrieve the localisation from the resource bundle.

bundleName - The name of the resource bundle.

locale - The locale for which to retrieve the localisation for the designated message key.

localisingClass - The class that is performing the localisation. This is used for loading the resource bundle.

locFac - The localisation factory for localising the strings. If this is null, no special localisation will be applied to the strings.

args - Optional arguments localised and afterwards passed to the corresponding localised message using String.format(Locale, String, Object...).

Returns:

The requested localised message.

See Also:

de.aristaflow.adept2.util.LocaleTools#getLocalisedMessage(String, String, Locale, Class, Object...)

fillLocalisedMessage

public static java.util.Map<java.util.Locale,java.lang.String> fillLocalisedMessage(java.util.Map<java.util.Locale,java.lang.String> localisedMessage,
                                                                                    java.lang.String msgKey,
                                                                                    java.lang.String bundleName,
                                                                                    java.util.List<java.util.Locale> locales,
                                                                                    java.lang.Class<?> localisingClass,
                                                                                    LocalisationFactory locFac,
                                                                                    LocalisedString... args)

Loads the designated message key from the designated bundle for the designated locales and stores them in the designated map. That is, a resource bundle with the designated name is loaded with the designated classloader for each of the designated locales. The designated localised strings will be resolved and merged with the message for the designated message key from the resource bundle. The resulting localised message is then stored in the designated map using the locale of the resource bundle. This locale may be a fallback for the requested locale. The root locale will always be included.

Parameters:

localisedMessage - The map to store the localised message with the locale of the corresponding resource bundle as key. If this is null a new map will be created and returned.

msgKey - The message key with which to retrieve the localisation from the resource bundles.

bundleName - The name of the resource bundle.

locales - The locales for which to retrieve localisations for the designated message key.

localisingClass - The class that is performing the localisation. This is used for loading the resource bundle.

locFac - The localisation factory for localising the strings. If this is null, no special localisation will be applied to the strings.

args - Optional arguments localised and afterwards passed to the corresponding localised message using String.format(Locale, String, Object...).

Returns:

The designated map containing the requested localisations. This is the designated map unless null is provided. If null is provided a new map will be created.

See Also:

de.aristaflow.adept2.util.LocaleTools#fillLocalisedMessage(Map, String, String, List, Class, Object...)