com.helger.commons.text.resolve

Class DefaultTextResolver

java.lang.Object

com.helger.commons.text.resolve.AbstractEnumTextResolverWithOverrideAndFallback

com.helger.commons.text.resolve.EnumTextResolverWithPropertiesOverrideAndFallback

com.helger.commons.text.resolve.DefaultTextResolver

All Implemented Interfaces:

IEnumTextResolver

@ThreadSafe
 @Singleton
public final class DefaultTextResolver
extends EnumTextResolverWithPropertiesOverrideAndFallback

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

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.commons.text.resolve.EnumTextResolverWithPropertiesOverrideAndFallback

DEFAULT_USE_RESOURCE_BUNDLE_CACHE, PREFIX_FALLBACK, PREFIX_OVERRIDE

Fields inherited from class com.helger.commons.text.resolve.AbstractEnumTextResolverWithOverrideAndFallback

DEFAULT_CHECK_FOR_FALLBACK, DEFAULT_CHECK_FOR_OVERRIDE

Method Summary

Modifier and Type	Method and Description
static DefaultTextResolver	getInstance()
static String	getTextStatic(Enum<?> aEnum, IHasText aTP, Locale aContentLocale) Get text
static String	getTextWithArgsStatic(Enum<?> aEnum, IHasTextWithArgs aTP, Locale aContentLocale) Deprecated. Don't call this; Use the version without "WithArgs" because there are no args
static String	getTextWithArgsStatic(Enum<?> aEnum, IHasTextWithArgs aTP, Locale aContentLocale, Object... aArgs) Get text
static boolean	isInstantiated()

Methods inherited from class com.helger.commons.text.resolve.EnumTextResolverWithPropertiesOverrideAndFallback

clearCache, getAllUsedFallbackBundleNames, getAllUsedOverrideBundleNames, internalGetFallbackString, internalGetOverrideString, isUseResourceBundleCache, setUseResourceBundleCache

Methods inherited from class com.helger.commons.text.resolve.AbstractEnumTextResolverWithOverrideAndFallback

getText, isCheckForFallback, isCheckForOverride, setCheckForFallback, setCheckForOverride

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.text.resolve.IEnumTextResolver

getTextWithArgs, getTextWithArgs

Method Detail

isInstantiated

public static boolean isInstantiated()

getInstance

@Nonnull
public static DefaultTextResolver getInstance()

Returns:

The singleton instance. Never null.

getTextStatic

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

Get text

Parameters:

aEnum - Enumeration entry. May not be null.

aTP - Text provider. May not be null.

aContentLocale - Locale to use. May not be null.

Returns:

null if the text is not available in the specific locale

getTextWithArgsStatic

@Nullable
 @Deprecated
 @DevelopersNote(value="Use getTextStatic instead when no argument is needed!")
public static String getTextWithArgsStatic(@Nonnull
                                                                                                                                                     Enum<?> aEnum,
                                                                                                                                                     @Nonnull
                                                                                                                                                     IHasTextWithArgs aTP,
                                                                                                                                                     @Nonnull
                                                                                                                                                     Locale aContentLocale)

Deprecated. Don't call this; Use the version without "WithArgs" because there are no args

Get text

Parameters:

aEnum - Enumeration entry. May not be null.

aTP - Text provider. May not be null.

aContentLocale - Locale to use. May not be null.

Returns:

null if the text is not available in the specific locale

getTextWithArgsStatic

@Nullable
public static String getTextWithArgsStatic(@Nonnull
                                                      Enum<?> aEnum,
                                                      @Nonnull
                                                      IHasTextWithArgs aTP,
                                                      @Nonnull
                                                      Locale aContentLocale,
                                                      @Nullable
                                                      Object... aArgs)

Get text

Parameters:

aEnum - Enumeration entry. May not be null.

aTP - Text provider. May not be null.

aContentLocale - Locale to use. May not be null.

aArgs - The arguments to be added for the placeholders. May neither be null nor empty.

Returns:

null if the text is not available in the specific locale