org.olat.core.gui.translator
Class PackageTranslator

java.lang.Object
  org.olat.core.logging.LogDelegator
      org.olat.core.gui.translator.PackageTranslator

All Implemented Interfaces:

Translator

public class PackageTranslator
extends LogDelegator
implements Translator

Author:

Felix Jost

Field Summary

Fields inherited from interface org.olat.core.gui.translator.Translator

NO_TRANSLATION_ERROR_PREFIX

Constructor Summary

PackageTranslator(java.lang.String packageName, java.util.Locale locale)
default with fallback mode

PackageTranslator(java.lang.String packageName, java.util.Locale locale, Translator fallBackTranslator)

Method Summary

static Translator	cascadeTranslators(PackageTranslator main, Translator fallback) cascade two translators
java.util.Locale	getLocale()
java.lang.String	getPackageName() The package of this package translator
void	setLocale(java.util.Locale locale) Not used normally.
java.lang.String	translate(java.lang.String key) Translates the string from the packageName localization file.
java.lang.String	translate(java.lang.String key, java.lang.String[] args)
java.lang.String	translate(java.lang.String key, java.lang.String[] args, boolean fallBackToDefaultLocale) Recoursive lookup for a key.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageTranslator

public PackageTranslator(java.lang.String packageName,
                         java.util.Locale locale,
                         Translator fallBackTranslator)

Parameters:

packageName -

locale -

fallBackTranslator -

PackageTranslator

public PackageTranslator(java.lang.String packageName,
                         java.util.Locale locale)

default with fallback mode

Parameters:

packageName -

locale -

Method Detail

cascadeTranslators

public static Translator cascadeTranslators(PackageTranslator main,
                                            Translator fallback)

cascade two translators

Parameters:

main -

fallback -

Returns:

translate

public java.lang.String translate(java.lang.String key)

Translates the string from the packageName localization file.

Specified by:

translate in interface Translator

Parameters:

key - The key to translate

Returns:

The internationalized strings

translate

public java.lang.String translate(java.lang.String key,
                                  java.lang.String[] args)

Specified by:

translate in interface Translator

Returns:

See Also:

Translator.translate(java.lang.String, java.lang.String[])

translate

public java.lang.String translate(java.lang.String key,
                                  java.lang.String[] args,
                                  boolean fallBackToDefaultLocale)

Recoursive lookup for a key. Used in translate(String key, String[] args). Should not be called directly, use translate(String key, String[] args). Must be public, because the definition is in an interface.

Specified by:

translate in interface Translator

args - the args to translate, may be null

fallBackToDefaultLocale - if true fall back to configurated default language.

Returns:

See Also:

Translator.translate(java.lang.String, java.lang.String[], boolean)

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface Translator

Returns:

See Also:

Translator.getLocale()

setLocale

public void setLocale(java.util.Locale locale)

Not used normally. Sets the locale. Use only if e.g. a translator (which should then be an instance variable of a controller) is needed in the DMZ area where no user is logged in yet

Specified by:

setLocale in interface Translator

Parameters:

locale - The locale to set

getPackageName

public java.lang.String getPackageName()

The package of this package translator

Returns: