com.helger.commons.text.resolve

Interface IEnumTextResolver

All Known Implementing Classes:

AbstractEnumTextResolverWithOverrideAndFallback, EnumTextResolverWithPropertiesOverrideAndFallback

public interface IEnumTextResolver

Base interface for an enum-based text resolver.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
String	getText(Enum<?> aEnum, ISimpleTextProvider aTP, Locale aContentLocale) Get the text of an enumeration item.
String	getTextWithArgs(Enum<?> aEnum, ITextProvider 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
                      ISimpleTextProvider 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
String getTextWithArgs(@Nonnull
                              Enum<?> aEnum,
                              @Nonnull
                              ITextProvider 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.