com.helger.commons.text.resolve

Class AbstractEnumTextResolverWithOverrideAndFallback

java.lang.Object

com.helger.commons.text.resolve.AbstractEnumTextResolverWithOverrideAndFallback

All Implemented Interfaces:

IEnumTextResolver

Direct Known Subclasses:

EnumTextResolverWithPropertiesOverrideAndFallback

@ThreadSafe
public abstract class AbstractEnumTextResolverWithOverrideAndFallback
extends Object
implements IEnumTextResolver

Resolves texts either from an override, a text provider or otherwise uses a fallback, based on the given enum constant.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractEnumTextResolverWithOverrideAndFallback()

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.
protected abstract String	internalGetFallbackString(String sID, Locale aContentLocale) This method must return the fallback string for the passed parameters.
protected abstract String	internalGetOverrideString(String sID, Locale aContentLocale) This method must return the override string for the passed parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractEnumTextResolverWithOverrideAndFallback

public AbstractEnumTextResolverWithOverrideAndFallback()

Method Detail

internalGetOverrideString

@Nullable
protected abstract String internalGetOverrideString(@Nonnull
                                        String sID,
                                        @Nonnull
                                        Locale aContentLocale)

This method must return the override string for the passed parameters.

Parameters:

sID - Unique string ID

aContentLocale - locale to use.

Returns:

The string in the passed locale. May be null.

internalGetFallbackString

@Nullable
protected abstract String internalGetFallbackString(@Nonnull
                                        String sID,
                                        @Nonnull
                                        Locale aContentLocale)

This method must return the fallback string for the passed parameters.

Parameters:

sID - Unique string ID

aContentLocale - locale to use.

Returns:

The string in the passed locale. May be null.

getText

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

Description copied from interface: IEnumTextResolver

Get the text of an enumeration item.

Specified by:

getText in interface IEnumTextResolver

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
public final String getTextWithArgs(@Nonnull
                              Enum<?> aEnum,
                              @Nonnull
                              ITextProvider aTP,
                              @Nonnull
                              Locale aContentLocale,
                              @Nullable
                              Object... aArgs)

Description copied from interface: IEnumTextResolver

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

Specified by:

getTextWithArgs in interface IEnumTextResolver

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.