org.gatein.api.common.i18n

Class LocalizedString

java.lang.Object

org.gatein.api.common.i18n.Localized<String>

org.gatein.api.common.i18n.LocalizedString

All Implemented Interfaces:

Serializable, Iterable<String>

public class LocalizedString
extends Localized<String>

A LocalizedString can represent a single value (non localized) or many values each mapping to a specific Locale

Author:

Nick Scavelli

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.gatein.api.common.i18n.Localized

Localized.Value<T extends Serializable>

Constructor Summary

Constructors

Constructor and Description
LocalizedString(Locale locale, String value) Constructor to create a localized string.
LocalizedString(LocalizedString localizedString)
LocalizedString(Map<Locale,String> valueMap) Constructor to create a localized string with multiple values.
LocalizedString(String value) Constructor to create a non localized string.

Method Summary

Methods

Modifier and Type	Method and Description
String	getValue() This method returns the value for a non localized string.
boolean	isLocalized() Indicates if the string is localized or not.
LocalizedString	setLocalizedValue(Locale locale, String value) This method will first remove the non localized value if one exists then sets the value for the specified locale.
LocalizedString	setValue(String value) This will clear any localized values, and convert the string to a non localized string.

Methods inherited from class org.gatein.api.common.i18n.Localized

equals, getLocalizedValue, getLocalizedValues, getValue, hashCode, iterator, removeLocalizedValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizedString

public LocalizedString(LocalizedString localizedString)

LocalizedString

public LocalizedString(String value)

Constructor to create a non localized string. The result will include a Value with a null Locale.

Parameters:

value - the value to represent the non localized string

LocalizedString

public LocalizedString(Locale locale,
               String value)

Constructor to create a localized string.

Parameters:

locale - the locale of the value

value - the value

LocalizedString

public LocalizedString(Map<Locale,String> valueMap)

Constructor to create a localized string with multiple values.

Parameters:

valueMap - the map containing the Locale->String mapping.

Method Detail

getValue

public String getValue()

This method returns the value for a non localized string. If the string is localized this will return null. This is equivalent to calling Localized.getValue(java.util.Locale) and passing in null for the Locale

Returns:

the value or null if the string is localized.

setValue

public LocalizedString setValue(String value)

This will clear any localized values, and convert the string to a non localized string.

Parameters:

value - the value

Returns:

the localized string

setLocalizedValue

public LocalizedString setLocalizedValue(Locale locale,
                                String value)

This method will first remove the non localized value if one exists then sets the value for the specified locale. If a locale already exists this will override the previous value mapped to that locale.

Overrides:

setLocalizedValue in class Localized<String>

Parameters:

locale - the locale

value - the value

Returns:

the localized string

isLocalized

public boolean isLocalized()

Indicates if the string is localized or not.

Returns:

true if the string is localized, false otherwise.