com.suncode.pwfl.translation

Interface Translator

All Known Subinterfaces:

ClassLoaderTranslator, PackageTranslator

All Known Implementing Classes:

AbstractTranslator, EmptyTranslator, PropertiesTranslator

@Api
public interface Translator

Translator is the standard way of translating key-base messages for given Locale.

Every registered in TranslatorRegistry translator is identified by unique (per scope) name.

Author:

Cezary Kozar 11 sie 2015

Method Summary

Modifier and Type	Method and Description
LocalizedString	getLocalizedString(String key) Creates LocalizedString with given key.
LocalizedString	getLocalizedString(String key, Locale locale) Creates LocalizedString with given key and locale.
LocalizedString	getLocalizedString(String key, Locale locale, Object... args) Creates LocalizedString with given key, locale and message arguments.
LocalizedString	getLocalizedString(String key, Object... args) Creates LocalizedString with given key and message arguments.
LocalizedString	getLocalizedString(String key, String defaultValue) Creates LocalizedString with given key and default value.
LocalizedString	getLocalizedString(String key, String[] fallbackKeys, String defaultValue) Creates LocalizedString with given key, fallback keys and default value.
LocalizedString	getLocalizedString(String key, String[] fallbackKeys, String defaultValue, Locale locale, Object... args) Creates LocalizedString.
LocalizedString	getLocalizedString(String key, String defaultValue, Locale locale) Creates LocalizedString with given key, locale and default value.
LocalizedString	getLocalizedString(String key, String defaultValue, Locale locale, Object... args) Creates LocalizedString with given key, default value, locale and message arguments.
LocalizedString	getLocalizedString(String key, String defaultValue, Object... args) Creates LocalizedString with given key, default value and message arguments.
String	getMessage(String key) Return translated message for given key using current user locale.
String	getMessage(String key, Locale locale) Return translated message for given key and locale.
String	getMessage(String key, Locale locale, Object... args) Return translated message for given key, locale and arguments.
String	getMessage(String key, Object... args) Return translated message for given key and arguments using current user locale.
Map<String,String>	getMessages(Locale locale) Returns key-value map with every available translations for given locale.

Method Detail

getMessages

Map<String,String> getMessages(Locale locale)

Returns key-value map with every available translations for given locale.

getMessage

String getMessage(String key)
           throws NoTranslationException

Return translated message for given key using current user locale.

Throws:

NoTranslationException

See Also:

getMessage(String, Locale, Object...)

getMessage

String getMessage(String key,
                  Locale locale)
           throws NoTranslationException

Return translated message for given key and locale.

Throws:

NoTranslationException

See Also:

getMessage(String, Locale, Object...)

getMessage

String getMessage(String key,
                  Object... args)
           throws NoTranslationException

Return translated message for given key and arguments using current user locale.

Throws:

NoTranslationException

See Also:

getMessage(String, Locale, Object...)

getMessage

String getMessage(String key,
                  Locale locale,
                  Object... args)
           throws NoTranslationException

Return translated message for given key, locale and arguments.

Parameters:

key - message key

locale - locale

args - optional placeholder arguments (e.g. {0} {1})

Returns:

translated message for given key

Throws:

NoTranslationException

getLocalizedString

LocalizedString getLocalizedString(String key)

Creates LocalizedString with given key.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   String defaultValue)

Creates LocalizedString with given key and default value.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   String[] fallbackKeys,
                                   String defaultValue)

Creates LocalizedString with given key, fallback keys and default value.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   Locale locale)

Creates LocalizedString with given key and locale.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   String defaultValue,
                                   Locale locale)

Creates LocalizedString with given key, locale and default value.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   Object... args)

Creates LocalizedString with given key and message arguments.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   String defaultValue,
                                   Object... args)

Creates LocalizedString with given key, default value and message arguments.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   Locale locale,
                                   Object... args)

Creates LocalizedString with given key, locale and message arguments.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   String defaultValue,
                                   Locale locale,
                                   Object... args)

Creates LocalizedString with given key, default value, locale and message arguments.

See Also:

getLocalizedString(String, String[], String, Locale, Object...)

getLocalizedString

LocalizedString getLocalizedString(String key,
                                   String[] fallbackKeys,
                                   String defaultValue,
                                   Locale locale,
                                   Object... args)

Creates LocalizedString.

Parameters:

key - message key

fallbackKeys - fallback keys

defaultValue - default value returned when no translation could be found

locale - locale

args - optional message arguments (e.g. {0} {1})

Returns:

LocalizedString

See Also:

LocalizedString