com.helger.commons.text

Interface ISimpleTextProvider

All Superinterfaces:

Serializable

All Known Subinterfaces:

IMultiLingualText, IReadonlyMultiLingualText, ISimpleMultiLingualText, ITextProvider

All Known Implementing Classes:

AbstractSimpleTextProvider, AbstractTextProvider, ConstantTextProvider, MultiLingualText, MultiLingualTextThreadSafe, ReadonlyMultiLingualText, ResourceBundleTextProvider, TextProvider

public interface ISimpleTextProvider
extends Serializable

Basic interface for object providing multilingual texts without arguments. See also ITextProvider for a derived interface with argument handling.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
String	getText(Locale aContentLocale) Get the text specific for the passed locale.
String	getTextWithLocaleFallback(Locale aContentLocale) Get the text specific for the passed locale.

Method Detail

getText

@Nullable
String getText(@Nonnull
                      Locale aContentLocale)

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

Parameters:

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

Returns:

null if no text for the given locale was found.

getTextWithLocaleFallback

@Nullable
String getTextWithLocaleFallback(@Nonnull
                                        Locale aContentLocale)

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

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)