com.helger.commons.text

Interface IMultiLingualText

All Superinterfaces:

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

All Known Implementing Classes:

MultiLingualText, MultiLingualTextThreadSafe

public interface IMultiLingualText
extends IReadonlyMultiLingualText, IClearable

Interface for a writable version of a multilingual text

Author:

Philip Helger

Method Summary

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	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 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

Methods inherited from interface com.helger.commons.state.IClearable

clear

Method Detail

addText

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

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

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

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

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

Remove the text with the specified locale.

Parameters:

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

Returns:

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

assignFrom

@Nonnull
EChange assignFrom(@Nonnull
                             IReadonlyMultiLingualText aMLT)

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

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

void addChangeNotifier(@Nonnull
                       IChangeNotify<IMultiLingualText> aCallback)

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

Parameters:

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