com.suncode.pwfl.translation

Class LocalizedString

java.lang.Object

com.suncode.pwfl.translation.LocalizedString

@Api
public class LocalizedString
extends Object

Dynamically translated String.

Message for given key is retrived within get() method. If there is no forced Locale, user current locale will be used.

Author:

Cezary Kozar 11 sie 2015

Constructor Summary

Constructors

Constructor and Description
LocalizedString(String key, String[] fallbackKeys, String defaultValue, Translator translator, Locale locale, Object... args)
LocalizedString(String key, String defaultValue, Translator translator, Locale locale, Object... args)
LocalizedString(String key, Translator translator, Object... args)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	get() Returns translated message.
String	getOptional() Returns translated message or key value if translation does not exists.
static String	getOrEmpty(LocalizedString string) Returns value of localized string or empty string "" if specified localized string is null.
int	hashCode()
static LocalizedString	of(String value) Creates LocalizedString with static value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizedString

public LocalizedString(String key,
                       Translator translator,
                       Object... args)

LocalizedString

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

LocalizedString

public LocalizedString(String key,
                       String[] fallbackKeys,
                       String defaultValue,
                       Translator translator,
                       Locale locale,
                       Object... args)

Method Detail

of

public static LocalizedString of(String value)

Creates LocalizedString with static value.

Parameters:

value - value

Returns:

LocalizedString which always returns given value

getOrEmpty

public static String getOrEmpty(LocalizedString string)

Returns value of localized string or empty string "" if specified localized string is null.

Parameters:

string - localized string

Returns:

not empty value

get

public String get()
           throws NoTranslationException

Returns translated message.

Throws:

NoTranslationException - no translation found and no default value specified

getOptional

public String getOptional()

Returns translated message or key value if translation does not exists.

See Also:

get()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object