com.helger.commons.text

Class AbstractMapBasedMultilingualText

java.lang.Object

com.helger.commons.text.AbstractHasText

com.helger.commons.text.AbstractHasTextWithArgs

com.helger.commons.text.AbstractReadOnlyMapBasedMultilingualText

com.helger.commons.text.AbstractMapBasedMultilingualText

All Implemented Interfaces:

IHasSize, IHasLocales, IClearable, IHasText, IHasTextWithArgs, IMultilingualText, IMutableMultilingualText, Serializable

Direct Known Subclasses:

MultilingualText

@NotThreadSafe
public abstract class AbstractMapBasedMultilingualText
extends AbstractReadOnlyMapBasedMultilingualText
implements IMutableMultilingualText

A Map based implementation of IMultilingualText that does also provide writing methods to the outside and is only to be used as a non-abstract base class.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractMapBasedMultilingualText()
protected	AbstractMapBasedMultilingualText(Map<Locale,String> aMapToUse) Protected constructor that specifies the underlying Map to use.

Method Summary

Modifier and Type	Method and Description
EChange	addText(Locale aContentLocale, String sText) Add a text in the specified locale.
EChange	assignFrom(IMultilingualText aMLT) Assign all fields from the passed object.
EChange	clear() Reset the contents of the element to the after-construction state.
CallbackList<IChangeCallback<IMutableMultilingualText>>	getChangeNotifyCallbacks()
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.AbstractReadOnlyMapBasedMultilingualText

containsLocale, containsLocaleWithFallback, equals, getAllLocales, getAllTexts, getLocaleCount, getSize, hashCode, internalAddText, internalAddText, internalClear, internalGetAllLocales, internalGetLocaleToUseWithFallback, internalGetMap, internalGetText, internalRemoveText, internalSetText, isEmpty, isPerformConsistencyChecks, setPerformConsistencyChecks, toString

Methods inherited from class com.helger.commons.text.AbstractHasTextWithArgs

getTextWithArgs, getTextWithArgs

Methods inherited from class com.helger.commons.text.AbstractHasText

getText

Methods inherited from class java.lang.Object

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

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

getAllTexts

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

getTextWithArgs, getTextWithArgs

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

getText

Methods inherited from interface com.helger.commons.locale.IHasLocales

containsLocale, containsLocaleWithFallback, getAllLocales, getLocaleCount

Methods inherited from interface com.helger.commons.lang.IHasSize

getSize, isEmpty

Constructor Detail

AbstractMapBasedMultilingualText

public AbstractMapBasedMultilingualText()

AbstractMapBasedMultilingualText

protected AbstractMapBasedMultilingualText(@Nonnull
                                           Map<Locale,String> aMapToUse)

Protected constructor that specifies the underlying Map to use. Use this constructor to e.g. provide a concurrent HashMap or similar.

Parameters:

aMapToUse - The map to use. Must not be null and must be writable.

Method Detail

addText

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

Description copied from interface: IMutableMultilingualText

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 IMutableMultilingualText

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 final EChange setText(@Nonnull
                                       Locale aContentLocale,
                                       @Nullable
                                       String sText)

Description copied from interface: IMutableMultilingualText

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 IMutableMultilingualText

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 final EChange removeText(@Nonnull
                                          Locale aContentLocale)

Description copied from interface: IMutableMultilingualText

Remove the text with the specified locale.

Specified by:

removeText in interface IMutableMultilingualText

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 final 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 final EChange assignFrom(@Nonnull
                                          IMultilingualText aMLT)

Description copied from interface: IMutableMultilingualText

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

Specified by:

assignFrom in interface IMutableMultilingualText

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(value="design")
public final CallbackList<IChangeCallback<IMutableMultilingualText>> getChangeNotifyCallbacks()

Specified by:

getChangeNotifyCallbacks in interface IMutableMultilingualText

Returns:

The change notify callbacks. Never null.