com.helger.commons.text.impl

Class AbstractTextProvider

java.lang.Object

com.helger.commons.text.impl.AbstractSimpleTextProvider

com.helger.commons.text.impl.AbstractTextProvider

All Implemented Interfaces:

ISimpleTextProvider, ITextProvider, Serializable

Direct Known Subclasses:

ConstantTextProvider, ResourceBundleTextProvider, TextProvider

public abstract class AbstractTextProvider
extends AbstractSimpleTextProvider
implements ITextProvider

An abstract implementation of the ITextProvider that has default implementations for the formatting things.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTextProvider()

Method Summary

Methods

Modifier and Type	Method and Description
String	getTextWithArgs(Locale aContentLocale, Object... aArgs) Get the text specific for the passed locale.
String	getTextWithLocaleFallbackAndArgs(Locale aContentLocale, Object... aArgs) Get the text specific for the passed locale.

Methods inherited from class com.helger.commons.text.impl.AbstractSimpleTextProvider

getText, getTextWithLocaleFallback, internalGetLocaleToUseWithFallback, internalGetText

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.ISimpleTextProvider

getText, getTextWithLocaleFallback

Constructor Detail

AbstractTextProvider

protected AbstractTextProvider()

Method Detail

getTextWithArgs

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

Description copied from interface: ITextProvider

Get the text specific for the passed locale. The implementation class MUST NOT add locale-generalisation when resolving the text ("de_DE" => "de" => default). The placeholders will be resolved with the Format.format(Object) method.

Specified by:

getTextWithArgs in interface ITextProvider

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.

getTextWithLocaleFallbackAndArgs

@Nullable
public final String getTextWithLocaleFallbackAndArgs(@Nonnull
                                               Locale aContentLocale,
                                               @Nullable
                                               Object... aArgs)

Description copied from interface: ITextProvider

Get the text specific for the passed locale. The implementation class MUST add locale-generalisation when resolving the text ("de_DE" => "de" => default). The placeholders will be resolved with the Format.format(Object) method.

Specified by:

getTextWithLocaleFallbackAndArgs in interface ITextProvider

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.

See Also:

LocaleUtils.getCalculatedLocaleListForResolving(Locale)