com.helger.commons.text.impl

Class MultiLingualText

java.lang.Object

com.helger.commons.text.impl.AbstractSimpleTextProvider

com.helger.commons.text.impl.AbstractTextProvider

com.helger.commons.text.impl.TextProvider

com.helger.commons.text.impl.MultiLingualText

All Implemented Interfaces:

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

@NotThreadSafe
public class MultiLingualText
extends TextProvider
implements IMultiLingualText

This class represents a multilingual text. It is internally represented as a map from Locale to the language dependent name.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IMultiLingualText	EMPTY_MULTILINGUAL_TEXT Default empty multilingual text - don't modify this object!!!

Fields inherited from class com.helger.commons.text.impl.TextProvider

DE, EN

Constructor Summary

Constructors

Constructor and Description
MultiLingualText()
MultiLingualText(IReadonlyMultiLingualText aMLT)
MultiLingualText(ISimpleMultiLingualText aSimpleMLT) Constructor especially for the static TextProvider.createXXX methods
MultiLingualText(Locale aContentLocale, String sValue)

Method Summary

Methods

Modifier and Type	Method and Description
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.
static IMultiLingualText	createFromMap(Map<String,String> aMap)
boolean	equals(Object o)
CallbackList<IChangeNotify<IMultiLingualText>>	getChangeNotifyCallbacks()
static IMultiLingualText	getCopyWithLocales(IReadonlyMultiLingualText aMLT, Collection<Locale> aContentLocales) Get a copy of this object with the specified locales.
int	hashCode()
EChange	removeText(Locale aContentLocale) Remove the text with the specified locale.
EChange	setText(Locale aContentLocale, String sText) Set a text in the specified locale.

Methods inherited from class com.helger.commons.text.impl.TextProvider

addTextDE, addTextEN, containsLocale, containsLocaleWithFallback, create_DE_EN, create_DE, create_EN, getAllLocales, getLocaleCount, getMap, internalAddText, internalClear, internalGetAllLocales, internalGetLocaleToUseWithFallback, internalGetMap, internalGetText, internalRemoveText, internalSetText, isEmpty, isPerformConsistencyChecks, setPerformConsistencyChecks, size, toString

Methods inherited from class com.helger.commons.text.impl.AbstractTextProvider

getTextWithArgs, getTextWithLocaleFallbackAndArgs

Methods inherited from class com.helger.commons.text.impl.AbstractSimpleTextProvider

getText, getTextWithLocaleFallback

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.text.IReadonlyMultiLingualText

getMap

Methods inherited from interface com.helger.commons.text.ITextProvider

getTextWithArgs, getTextWithLocaleFallbackAndArgs

Methods inherited from interface com.helger.commons.text.ISimpleTextProvider

getText, getTextWithLocaleFallback

Methods inherited from interface com.helger.commons.IHasLocales

containsLocale, containsLocaleWithFallback, getAllLocales, getLocaleCount

Methods inherited from interface com.helger.commons.IHasSize

isEmpty, size

Field Detail

EMPTY_MULTILINGUAL_TEXT

public static final IMultiLingualText EMPTY_MULTILINGUAL_TEXT

Default empty multilingual text - don't modify this object!!!

Constructor Detail

MultiLingualText

public MultiLingualText()

MultiLingualText

public MultiLingualText(@Nonnull
                Locale aContentLocale,
                @Nonnull
                String sValue)

MultiLingualText

public MultiLingualText(@Nonnull
                ISimpleMultiLingualText aSimpleMLT)

Constructor especially for the static TextProvider.createXXX methods

Parameters:

aSimpleMLT - The simple multi lingual text to use.

MultiLingualText

public MultiLingualText(@Nonnull
                IReadonlyMultiLingualText aMLT)

Method Detail

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.

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.

getChangeNotifyCallbacks

@Nonnull
@ReturnsMutableObject(reason="design")
public CallbackList<IChangeNotify<IMultiLingualText>> getChangeNotifyCallbacks()

Specified by:

getChangeNotifyCallbacks in interface IMultiLingualText

Returns:

The change notify callbacks. Never null.

equals

public boolean equals(Object o)

Overrides:

equals in class TextProvider

hashCode

public int hashCode()

Overrides:

hashCode in class TextProvider

createFromMap

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

getCopyWithLocales

@Nonnull
public static IMultiLingualText getCopyWithLocales(@Nonnull
                                           IReadonlyMultiLingualText aMLT,
                                           @Nonnull
                                           Collection<Locale> aContentLocales)

Get a copy of this object with the specified locales. The default locale is copied.

Parameters:

aMLT - The initial multi lingual text.

aContentLocales - The list of locales of which the strings are desired. May not be null.

Returns:

The object containing only the texts of the given locales. Never null.