Package com.helger.commons.text.resolve

Interface IEnumTextResolver

All Known Implementing Classes:

AbstractEnumTextResolverWithOverrideAndFallback, DefaultTextResolver, EnumTextResolverWithPropertiesOverrideAndFallback

public interface IEnumTextResolver

Base interface for an enum-based text resolver.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
String	getText(Enum<?> aEnum, IHasText aTP, Locale aContentLocale)	Get the text of an enumeration item.
default String	getTextWithArgs(Enum<?> aEnum, IHasTextWithArgs aTP, Locale aContentLocale)	Deprecated. Don't call this; Use getText(Enum, IHasText, Locale) instead when no argument is needed
default String	getTextWithArgs(Enum<?> aEnum, IHasTextWithArgs aTP, Locale aContentLocale, Object... aArgs)	Get the text of an enumeration item with placeholder texts being replaced.

Method Detail

getText

@Nullable
String getText(@Nonnull
               Enum<?> aEnum,
               @Nonnull
               IHasText aTP,
               @Nonnull
               Locale aContentLocale)

Get the text of an enumeration item.

Parameters:

aEnum - The enumeration item to get the unique ID of. May not be null.

aTP - The text provider containing the text. May not be null.

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

Returns:

null if no text could be resolved.

getTextWithArgs

@Nullable
@Deprecated(forRemoval=false)
@DevelopersNote("Use getText instead when no argument is needed")
default String getTextWithArgs(@Nonnull
                               Enum<?> aEnum,
                               @Nonnull
                               IHasTextWithArgs aTP,
                               @Nonnull
                               Locale aContentLocale)

Deprecated.

Don't call this; Use getText(Enum, IHasText, Locale) instead when no argument is needed

Get the text of an enumeration item.

Parameters:

aEnum - The enumeration item to get the unique ID of. May not be null.

aTP - The text provider containing the text. May not be null.

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

Returns:

null if no text could be resolved.

getTextWithArgs

@Nullable
default String getTextWithArgs(@Nonnull
                               Enum<?> aEnum,
                               @Nonnull
                               IHasTextWithArgs aTP,
                               @Nonnull
                               Locale aContentLocale,
                               @Nullable
                               Object... aArgs)

Get the text of an enumeration item with placeholder texts being replaced.

Parameters:

aEnum - The enumeration item to get the unique ID of. May not be null.

aTP - The text provider containing the text. May not be null.

aContentLocale - The locale to be used. 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 could be resolved.