com.helger.commons.text

Interface IHasTextWithArgs

All Superinterfaces:

IHasText

All Known Subinterfaces:

IMultilingualText, IMutableMultilingualText

All Known Implementing Classes:

AbstractHasTextWithArgs, AbstractMapBasedMultilingualText, AbstractReadOnlyMapBasedMultilingualText, ConstantHasTextWithArgs, MultilingualText, ReadOnlyMultilingualText, ResourceBundleTextProvider

public interface IHasTextWithArgs
extends IHasText

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) Deprecated. Use IHasText.getText(Locale) instead!
String	getTextWithArgs(Locale aContentLocale, Object... aArgs) Get the text specific for the passed locale.

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

getText

Method Detail

getTextWithArgs

@Nullable
@Deprecated
@DevelopersNote(value="Use getText instead!")
String getTextWithArgs(@Nonnull
                                                             Locale aContentLocale)

Deprecated. Use IHasText.getText(Locale) instead!

Get the text specific for the passed locale. The implementation class MAY 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.

getTextWithArgs

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

Get the text specific for the passed locale. The implementation class MAY 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.