com.phloc.commons.text.impl

Class MultiLingualTextThreadSafe

java.lang.Object

com.phloc.commons.text.impl.MultiLingualTextThreadSafe

All Implemented Interfaces:

IHasLocales, IHasSize, IClearable, IMultiLingualText, IReadonlyMultiLingualText, ISimpleMultiLingualText, ISimpleTextProvider, ITextProvider, Serializable

@ThreadSafe
public class MultiLingualTextThreadSafe
extends Object
implements IMultiLingualText

This class represents a thread safe multilingual text. It wraps an existing MultiLingualText and adds a read write lock around it.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	m_aRWLock

Constructor Summary

Constructors

Constructor and Description
MultiLingualTextThreadSafe()
MultiLingualTextThreadSafe(IReadonlyMultiLingualText aMLT)
MultiLingualTextThreadSafe(ISimpleMultiLingualText aSimpleMLT) Constructor especially for the static TextProvider.createXXX methods

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeNotifier(IChangeNotify<IMultiLingualText> aCallback) Add a notification callback that is called, when the object is changed.
EChange	addText(Locale aContentLocale, String sText) Add a text in the specified locale.
EChange	assignFrom(IReadonlyMultiLingualText aMLT) Assign all fields from the passed object.
EChange	clear() Reset the contents of the element to the after-construction state.
boolean	containsLocale(Locale aContentLocale) Check if the passed locale is directly contained.
boolean	containsLocaleWithFallback(Locale aContentLocale) Check if the passed locale is directly or by fallback contained.
static IMultiLingualText	createFromMap(Map<String,String> aMap)
boolean	equals(Object o)
Set<Locale>	getAllLocales()
int	getLocaleCount()
Map<Locale,String>	getMap()
String	getText(Locale aContentLocale) Get the text specific for the passed locale.
String	getTextWithArgs(Locale aContentLocale, Object... aArgs) Get the text specific for the passed locale.
String	getTextWithLocaleFallback(Locale aContentLocale) Get the text specific for the passed locale.
String	getTextWithLocaleFallbackAndArgs(Locale aContentLocale, Object... aArgs) Get the text specific for the passed locale.
int	hashCode()
boolean	isEmpty()
EChange	removeText(Locale aContentLocale) Remove the text with the specified locale.
EChange	setText(Locale aContentLocale, String sText) Set a text in the specified locale.
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

m_aRWLock

protected final ReadWriteLock m_aRWLock

Constructor Detail

MultiLingualTextThreadSafe

public MultiLingualTextThreadSafe()

MultiLingualTextThreadSafe

public MultiLingualTextThreadSafe(@Nonnull
                          ISimpleMultiLingualText aSimpleMLT)

Constructor especially for the static TextProvider.createXXX methods

Parameters:

aSimpleMLT - The simple multi lingual text to use.

MultiLingualTextThreadSafe

public MultiLingualTextThreadSafe(@Nonnull
                          IReadonlyMultiLingualText aMLT)

Method Detail

getText

@Nullable
public String getText(@Nonnull
                      Locale aContentLocale)

Description copied from interface: ISimpleTextProvider

Get the text specific for the passed locale. The implementation class MUST NOT add locale-generalisation when resolving the text ("de_DE" => "de" => default).

Specified by:

getText in interface ISimpleTextProvider

Parameters:

aContentLocale - The locale to use. May not be null.

Returns:

null if no text for the given locale was found.

getTextWithLocaleFallback

@Nullable
public String getTextWithLocaleFallback(@Nonnull
                                        Locale aContentLocale)

Description copied from interface: ISimpleTextProvider

Get the text specific for the passed locale. The implementation class MUST add locale-generalisation when resolving the text ("de_DE" => "de" => default).

Specified by:

getTextWithLocaleFallback in interface ISimpleTextProvider

Parameters:

aContentLocale - The locale to use. May not be null.

Returns:

null if no text for the given locale was found.

See Also:

LocaleUtils.getCalculatedLocaleListForResolving(Locale)

getTextWithArgs

@Nullable
public String getTextWithArgs(@Nonnull
                              Locale aContentLocale,
                              @Nullable
                              Object... aArgs)

Description copied from interface: ITextProvider

Get the text specific for the passed locale. The implementation class MUST NOT add locale-generalisation when resolving the text ("de_DE" => "de" => default). The placeholders will be resolved with the Format.format(Object) method.

Specified by:

getTextWithArgs in interface ITextProvider

Parameters:

aContentLocale - The locale to use. May not be null.

aArgs - The arguments to be added into the string. May be null but this makes no sense.

Returns:

null if no text for the given locale was found.

getTextWithLocaleFallbackAndArgs

@Nullable
public String getTextWithLocaleFallbackAndArgs(@Nonnull
                                               Locale aContentLocale,
                                               @Nullable
                                               Object... aArgs)

Description copied from interface: ITextProvider

Get the text specific for the passed locale. The implementation class MUST add locale-generalisation when resolving the text ("de_DE" => "de" => default). The placeholders will be resolved with the Format.format(Object) method.

Specified by:

getTextWithLocaleFallbackAndArgs in interface ITextProvider

Parameters:

aContentLocale - The locale to use. May not be null.

aArgs - The arguments to be added into the string. May be null but this makes no sense.

Returns:

null if no text for the given locale was found.

See Also:

LocaleUtils.getCalculatedLocaleListForResolving(Locale)

addText

@Nonnull
public EChange addText(@Nonnull
                      Locale aContentLocale,
                      @Nullable
                      String sText)

Description copied from interface: IMultiLingualText

Add a text in the specified locale. If a text with the same locale is already present, false is returned.

Specified by:

addText in interface IMultiLingualText

Parameters:

aContentLocale - The locale in which the text should be set. May not be null.

sText - The text to be set. May be null.

Returns:

EChange.CHANGED if the text was added, EChange.UNCHANGED otherwise.

setText

@Nonnull
public EChange setText(@Nonnull
                      Locale aContentLocale,
                      @Nullable
                      String sText)

Description copied from interface: IMultiLingualText

Set a text in the specified locale. If a text with the same locale is already present, the old value is overwritten.

Specified by:

setText in interface IMultiLingualText

Parameters:

aContentLocale - The locale in which the text should be set. May not be null .

sText - The text to be set. May be null.

Returns:

EChange.CHANGED if the text was set, EChange.UNCHANGED otherwise.

getLocaleCount

@Nonnegative
public int getLocaleCount()

Specified by:

getLocaleCount in interface IHasLocales

Returns:

The number of contained locales. Always ≥ 0.

containsLocale

public boolean containsLocale(@Nullable
                     Locale aContentLocale)

Description copied from interface: IHasLocales

Check if the passed locale is directly contained.

Specified by:

containsLocale in interface IHasLocales

Parameters:

aContentLocale - The locale to check. May be null.

Returns:

true if the locale is directly contained, false if not.

containsLocaleWithFallback

public boolean containsLocaleWithFallback(@Nullable
                                 Locale aContentLocale)

Description copied from interface: IHasLocales

Check if the passed locale is directly or by fallback contained. The implementation class MUST add locale-generalisation when resolving the text ("de_DE" => "de" => default).

Specified by:

containsLocaleWithFallback in interface IHasLocales

Parameters:

aContentLocale - The locale to check. May be null.

Returns:

true if the locale is contained, false if not.

getMap

@Nonnull
@ReturnsMutableCopy
public Map<Locale,String> getMap()

Specified by:

getMap in interface IReadonlyMultiLingualText

Returns:

A map over all contained locale/text pairs. Never null .

size

@Nonnegative
public int size()

Specified by:

size in interface IHasSize

Returns:

The number of contained elements. Always ≥ 0.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IHasSize

Returns:

true if no items are present, false if at least a single item is present.

See Also:

IHasSize.size()

getAllLocales

@Nonnull
@ReturnsMutableCopy
public Set<Locale> getAllLocales()

Specified by:

getAllLocales in interface IHasLocales

Returns:

The locales of this object. May not be null.

removeText

@Nonnull
public EChange removeText(@Nonnull
                         Locale aContentLocale)

Description copied from interface: IMultiLingualText

Remove the text with the specified locale.

Specified by:

removeText in interface IMultiLingualText

Parameters:

aContentLocale - The locale to be removed. May not be null.

Returns:

EChange.CHANGED if the text was remove, EChange.UNCHANGED otherwise.

clear

@Nonnull
public EChange clear()

Description copied from interface: IClearable

Reset the contents of the element to the after-construction state.

Specified by:

clear in interface IClearable

Returns:

EChange.CHANGED if at least one element was cleared, EChange.UNCHANGED otherwise.

assignFrom

@Nonnull
public EChange assignFrom(@Nonnull
                         IReadonlyMultiLingualText aMLT)

Description copied from interface: IMultiLingualText

Assign all fields from the passed object. All existing texts are removed!

Specified by:

assignFrom in interface IMultiLingualText

Parameters:

aMLT - The object to read the content from. May not be null.

Returns:

EChange.CHANGED if the assignment changed anything, EChange.UNCHANGED otherwise.

addChangeNotifier

public void addChangeNotifier(@Nonnull
                     IChangeNotify<IMultiLingualText> aCallback)

Description copied from interface: IMultiLingualText

Add a notification callback that is called, when the object is changed.

Specified by:

addChangeNotifier in interface IMultiLingualText

Parameters:

aCallback - The callback to add. May not be null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createFromMap

@Nonnull
public static IMultiLingualText createFromMap(@Nonnull
                                      Map<String,String> aMap)