org.gatein.api.common.i18n

Class Localized<T extends Serializable>

java.lang.Object

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

All Implemented Interfaces:

Serializable, Iterable<T>

Direct Known Subclasses:

LocalizedString

public abstract class Localized<T extends Serializable>
extends Object
implements Iterable<T>, Serializable

Base class for localizing values of type T.

Author:

Nick Scavelli

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Localized.Value<T extends Serializable> Value object representing the mapping of a Locale to a value of type T.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Localized(Locale locale, T value)
protected	Localized(Localized<T> localized)
protected	Localized(Map<Locale,T> valueMap)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Localized.Value<T>	getLocalizedValue(Locale locale) Gets the value mapped to the specific locale.
Collection<Localized.Value<T>>	getLocalizedValues() Returns a collection of values representing the mapping of Locale to type T
T	getValue(Locale locale) Gets the T value mapped to the specific locale.
int	hashCode()
Iterator<T>	iterator()
void	removeLocalizedValue(Locale locale) Will remove the value mapped to the locale.
Localized<T>	setLocalizedValue(Locale locale, T value) Sets the value for the specified locale.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Localized

protected Localized(Localized<T> localized)

Localized

protected Localized(Locale locale,
         T value)

Localized

protected Localized(Map<Locale,T> valueMap)

Method Detail

getLocalizedValue

public Localized.Value<T> getLocalizedValue(Locale locale)

Gets the value mapped to the specific locale. Can return null if no mapping exists.

Parameters:

locale - the locale of the value

Returns:

the value object representing the mapping between locale and value.

getValue

public T getValue(Locale locale)

Gets the T value mapped to the specific locale. Can return null if no mapping exists. Convenience method for getLocalizedValue(Locale).getValue()

Parameters:

locale - the locale of the value

Returns:

the value of type T

setLocalizedValue

public Localized<T> setLocalizedValue(Locale locale,
                             T value)

Sets the value for the specified locale. If a locale already exists, will override the previous value mapped to that locale.

Parameters:

locale - the locale

value - the value

Returns:

this

removeLocalizedValue

public void removeLocalizedValue(Locale locale)

Will remove the value mapped to the locale.

Parameters:

locale - the locale

getLocalizedValues

public Collection<Localized.Value<T>> getLocalizedValues()

Returns a collection of values representing the mapping of Locale to type T

Returns:

the collection of values

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends Serializable>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object