com.suncode.pwfl.translation

Class AbstractTranslator

java.lang.Object

com.suncode.pwfl.translation.AbstractTranslator

All Implemented Interfaces:

ClassLoaderTranslator, PackageTranslator, Translator

Direct Known Subclasses:

EmptyTranslator, PropertiesTranslator

@Api
public abstract class AbstractTranslator
extends Object
implements PackageTranslator, ClassLoaderTranslator

Common Translator implementation.

Author:

Cezary Kozar 11 sie 2015

Constructor Summary

Constructors

Constructor and Description
AbstractTranslator()
AbstractTranslator(Translator parent)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTranslatedPackage(String packageName) Adds package, that contains classes which should be translated with this translator.
boolean	equals(Object obj)
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 defaultValue, Locale locale) Creates LocalizedString with given key, locale and default value.
LocalizedString	getLocalizedString(String key, String defaultValue, Locale locale, Object... args) Creates LocalizedString.
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.
int	hashCode()
protected abstract String	resolveMessage(String key, Locale locale, Object... args)
void	setParent(Translator parent) Sets this translator parent.
void	setTranslatedClassLoader(ClassLoader classLoader)
ClassLoader	translatedClassLoader() ClassLoader, for which this translator will be registered.
Set<String>	translatedPackages() Packages, for which this translator will be registered.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.suncode.pwfl.translation.Translator

getMessages

Constructor Detail

AbstractTranslator

public AbstractTranslator()

AbstractTranslator

public AbstractTranslator(Translator parent)

Method Detail

addTranslatedPackage

public void addTranslatedPackage(String packageName)

Adds package, that contains classes which should be translated with this translator.

Parameters:

packageName - package name

setTranslatedClassLoader

public void setTranslatedClassLoader(ClassLoader classLoader)

setParent

public void setParent(Translator parent)

Sets this translator parent.

resolveMessage

protected abstract String resolveMessage(String key,
                    Locale locale,
                    Object... args)
                                  throws NoTranslationException

Throws:

NoTranslationException

translatedPackages

public Set<String> translatedPackages()

Description copied from interface: PackageTranslator

Packages, for which this translator will be registered.

Specified by:

translatedPackages in interface PackageTranslator

translatedClassLoader

public ClassLoader translatedClassLoader()

Description copied from interface: ClassLoaderTranslator

ClassLoader, for which this translator will be registered.

Specified by:

translatedClassLoader in interface ClassLoaderTranslator

getMessage

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

Description copied from interface: Translator

Return translated message for given key, locale and arguments.

Specified by:

getMessage in interface Translator

Parameters:

key - message key

locale - locale

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

Returns:

translated message for given key

Throws:

NoTranslationException

getMessage

public String getMessage(String key)
                  throws NoTranslationException

Description copied from interface: Translator

Return translated message for given key using current user locale.

Specified by:

getMessage in interface Translator

Throws:

NoTranslationException

See Also:

Translator.getMessage(String, Locale, Object...)

getMessage

public String getMessage(String key,
                Locale locale)
                  throws NoTranslationException

Description copied from interface: Translator

Return translated message for given key and locale.

Specified by:

getMessage in interface Translator

Throws:

NoTranslationException

See Also:

Translator.getMessage(String, Locale, Object...)

getMessage

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

Description copied from interface: Translator

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

Specified by:

getMessage in interface Translator

Throws:

NoTranslationException

See Also:

Translator.getMessage(String, Locale, Object...)

getLocalizedString

public LocalizedString getLocalizedString(String key)

Description copied from interface: Translator

Creates LocalizedString with given key.

Specified by:

getLocalizedString in interface Translator

See Also:

Translator.getLocalizedString(String, String, Locale, Object...)

getLocalizedString

public LocalizedString getLocalizedString(String key,
                                 String defaultValue)

Description copied from interface: Translator

Creates LocalizedString with given key and default value.

Specified by:

getLocalizedString in interface Translator

See Also:

Translator.getLocalizedString(String, String, Locale, Object...)

getLocalizedString

public LocalizedString getLocalizedString(String key,
                                 Locale locale)

Description copied from interface: Translator

Creates LocalizedString with given key and locale.

Specified by:

getLocalizedString in interface Translator

See Also:

Translator.getLocalizedString(String, String, Locale, Object...)

getLocalizedString

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

Description copied from interface: Translator

Creates LocalizedString with given key, locale and default value.

Specified by:

getLocalizedString in interface Translator

See Also:

Translator.getLocalizedString(String, String, Locale, Object...)

getLocalizedString

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

Description copied from interface: Translator

Creates LocalizedString with given key and message arguments.

Specified by:

getLocalizedString in interface Translator

See Also:

Translator.getLocalizedString(String, String, Locale, Object...)

getLocalizedString

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

Description copied from interface: Translator

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

Specified by:

getLocalizedString in interface Translator

See Also:

Translator.getLocalizedString(String, String, Locale, Object...)

getLocalizedString

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

Description copied from interface: Translator

Creates LocalizedString with given key, locale and message arguments.

Specified by:

getLocalizedString in interface Translator

See Also:

Translator.getLocalizedString(String, String, Locale, Object...)

getLocalizedString

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

Description copied from interface: Translator

Creates LocalizedString.

Specified by:

getLocalizedString in interface Translator

Parameters:

key - message key

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object