com.helger.commons.text

Interface IMultilingualText

All Superinterfaces:

IHasSize, IHasText, IHasTextWithArgs, Serializable

All Known Subinterfaces:

IMutableMultilingualText

All Known Implementing Classes:

AbstractMapBasedMultilingualText, AbstractReadOnlyMapBasedMultilingualText, MultilingualText, ReadOnlyMultilingualText

@MustImplementEqualsAndHashcode
public interface IMultilingualText
extends IHasTextWithArgs, IHasSize

Read-only interface for a multilingual text

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
boolean	containsLocale(Locale aLocale) Check if the passed locale is directly contained.
boolean	containsLocaleWithFallback(Locale aLocale) Check if the passed locale is directly or by fallback contained.
ICommonsCollection<Locale>	getAllLocales()
ICommonsMap<Locale,String>	getAllTexts()

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

getAsHasDisplayTextWithArgs, getTextWithArgs, getTextWithArgs

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

getAsHasDisplayText, getComparatorCollating, getText

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

isEmpty, isNotEmpty, size

Method Detail

getAllLocales

@Nonnull
 @ReturnsMutableCopy
ICommonsCollection<Locale> getAllLocales()

Returns:

The locales of this object. May not be null.

containsLocale

boolean containsLocale(@Nullable
                       Locale aLocale)

Check if the passed locale is directly contained.

Parameters:

aLocale - The locale to check. May be null.

Returns:

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

containsLocaleWithFallback

boolean containsLocaleWithFallback(@Nullable
                                   Locale aLocale)

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

Parameters:

aLocale - The locale to check. May be null.

Returns:

true if the locale is contained, false if not.

getAllTexts

@Nonnull
 @ReturnsMutableCopy
ICommonsMap<Locale,String> getAllTexts()

Returns:

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