com.phloc.commons.text

Interface ITextProvider

All Superinterfaces:

ISimpleTextProvider, Serializable

All Known Subinterfaces:

IMultiLingualText, IReadonlyMultiLingualText, ISimpleMultiLingualText

All Known Implementing Classes:

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

public interface ITextProvider
extends ISimpleTextProvider

Basic interface for object providing multilingual texts with and without arguments.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
String	getTextWithArgs(Locale aContentLocale, Object... aArgs) Get the text specific for the passed locale.
String	getTextWithLocaleFallbackAndArgs(Locale aContentLocale, Object... aArgs) Get the text specific for the passed locale.

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

getText, getTextWithLocaleFallback

Method Detail

getTextWithArgs

@Nullable
String getTextWithArgs(@Nonnull
                              Locale aContentLocale,
                              @Nullable
                              Object... aArgs)

Get the text specific for the passed locale. The implementation class MUST NOT add locale-generalisation when resolving the text ("de_DE" => "de" => default). The placeholders will be resolved with the Format.format(Object) method.

Parameters:

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

aArgs - The arguments to be added into the string. May be null but this makes no sense.

Returns:

null if no text for the given locale was found.

getTextWithLocaleFallbackAndArgs

@Nullable
String getTextWithLocaleFallbackAndArgs(@Nonnull
                                               Locale aContentLocale,
                                               @Nullable
                                               Object... aArgs)

Get the text specific for the passed locale. The implementation class MUST add locale-generalisation when resolving the text ("de_DE" => "de" => default). The placeholders will be resolved with the Format.format(Object) method.

Parameters:

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

aArgs - The arguments to be added into the string. May be null but this makes no sense.

Returns:

null if no text for the given locale was found.

See Also:

LocaleUtils.getCalculatedLocaleListForResolving(Locale)