com.communote.server.persistence.common.messages

Class ResourceBundleManager

java.lang.Object

com.communote.server.persistence.common.messages.ResourceBundleManager

public class ResourceBundleManager
extends Object

The resource bundle manager controls the message source and takes care of providing it.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
void	addBasename(String basename) Add a basename pointing to resource bundles with translations.
void	addBasenameToTop(String basename) Like addBasename(String) but adds the resource bundles referenced by the basename to the top so that they will be searched before those provided by addBasename(String).
void	addLocalizations(String key, Locale locale, Map<String,String> localizations) Adds a map with additional localizations for a specified local to this manager.
String	evaluateText(String messageKey, Locale locale, Map<String,Object> model) Method to get a message and let it parse through Velocity.
String	getI18NCustomText(String msgKey, Locale locale) Convenience method for getting a i18n key's value.
String	getText(String msgKey, Locale locale, Object... arguments) Convenience method for getting a i18n key's value.
Set<String>	getUsedLanguageCodes()
static String	i18NCustomText(String msgKey, Locale locale) Convenience method for getting a i18n key's value.
static ResourceBundleManager	instance()
static boolean	isCustomMessageKey(String msgKey) Test whether the key belongs to a message that can be overridden in LocalizationManagement.
boolean	isUsedLanguage(String languageCode)
boolean	knowsMessageKey(String msgKey, Object[] args, Locale locale)
void	removeBasename(String basename) Removes the given basename.
void	removeLocalizations(String key) Removes the additional localization for the given key.

Methods inherited from class java.lang.Object

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

Method Detail

i18NCustomText

public static String i18NCustomText(String msgKey,
                                    Locale locale)

Convenience method for getting a i18n key's value. Use this method to check if a database value represents a message key.

Parameters:

msgKey - The possible message key

locale - the current locale

Returns:

The localized text

instance

public static ResourceBundleManager instance()

Returns:

the instance of the manager

isCustomMessageKey

public static boolean isCustomMessageKey(String msgKey)

Test whether the key belongs to a message that can be overridden in LocalizationManagement.

Parameters:

msgKey - the key to test

Returns:

true if the key belongs to a message that can be overridden in LocalizationManagement

addBasename

public void addBasename(String basename)

Add a basename pointing to resource bundles with translations. Resource bundles are searched sequentially for a matching translation. Bundles that were added earlier can therefore override translations provided by bundles that were added later. Resource bundles provided with this method will be searched for translations after those provided by addLocalizations(String, Locale, Map)

Parameters:

basename - The basename of the resource bundle without file extension or language code. If the resource bundles should be searched on the classpath the basename has to start with classpath:.

addBasenameToTop

public void addBasenameToTop(String basename)

Like addBasename(String) but adds the resource bundles referenced by the basename to the top so that they will be searched before those provided by addBasename(String). Translations provided by addLocalizations(String, Locale, Map) are still having a higher precedence.

Parameters:

basename - The basename of the resource bundle without file extension or language code. If the resource bundles should be searched on the classpath the basename has to start with classpath:.

addLocalizations

public void addLocalizations(String key,
                             Locale locale,
                             Map<String,String> localizations)

Adds a map with additional localizations for a specified local to this manager.

Parameters:

key - Key of the localizations. If there is already a dictionary for this key, it will be overwritten.

locale - The locale the localizations are for.

localizations - The localizations. The key is the message key and and value the value.

evaluateText

public String evaluateText(String messageKey,
                           Locale locale,
                           Map<String,Object> model)

Method to get a message and let it parse through Velocity.

Parameters:

messageKey - Message key to load.

locale - The locale.

model - The model for the Velocity context.

Returns:

The final text.

getI18NCustomText

public String getI18NCustomText(String msgKey,
                                Locale locale)

Convenience method for getting a i18n key's value. Use this method to check if a database value represents a message key.

Parameters:

msgKey - The possible message key

locale - the current locale

Returns:

The localized text

getText

public String getText(String msgKey,
                      Locale locale,
                      Object... arguments)

Convenience method for getting a i18n key's value.

Parameters:

msgKey - The message key

locale - the current locale.

arguments - Argument for the message.

Returns:

The localized text

getUsedLanguageCodes

public Set<String> getUsedLanguageCodes()

Returns:

A set of language codes and localization exists.

isUsedLanguage

public boolean isUsedLanguage(String languageCode)

Parameters:

languageCode - The language code to check.

Returns:

True, if there are localizations for the given language code are available.

knowsMessageKey

public boolean knowsMessageKey(String msgKey,
                               Object[] args,
                               Locale locale)

Parameters:

msgKey - The message key

args - the arguments for the message

locale - the current locale

Returns:

true if the message exists

removeBasename

public void removeBasename(String basename)

Removes the given basename.

Parameters:

basename - The basename.

removeLocalizations

public void removeLocalizations(String key)

Removes the additional localization for the given key.

Parameters:

key - Key of the localizations.