com.helger.commons.text.impl

Class AbstractSimpleTextProvider

java.lang.Object

com.helger.commons.text.impl.AbstractSimpleTextProvider

All Implemented Interfaces:

ISimpleTextProvider, Serializable

Direct Known Subclasses:

AbstractTextProvider

public abstract class AbstractSimpleTextProvider
extends Object
implements ISimpleTextProvider

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

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSimpleTextProvider()

Method Summary

Methods

Modifier and Type	Method and Description
String	getText(Locale aContentLocale) Get the text specific for the passed locale.
String	getTextWithLocaleFallback(Locale aContentLocale) Get the text specific for the passed locale.
protected abstract Locale	internalGetLocaleToUseWithFallback(Locale aContentLocale) Determine the locale to use.
protected abstract String	internalGetText(Locale aContentLocale) Main text resolving

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSimpleTextProvider

protected AbstractSimpleTextProvider()

Method Detail

internalGetText

@Nullable
protected abstract String internalGetText(@Nonnull
                              Locale aContentLocale)

Main text resolving

Parameters:

aContentLocale - locale to use

Returns:

null if no such text present in the passed locale

internalGetLocaleToUseWithFallback

@Nullable
protected abstract Locale internalGetLocaleToUseWithFallback(@Nonnull
                                                 Locale aContentLocale)

Determine the locale to use.

Parameters:

aContentLocale - Requested locale

Returns:

The locale to use. May be null.

getText

@Nullable
public final String getText(@Nonnull
                      Locale aContentLocale)

Description copied from interface: ISimpleTextProvider

Get the text specific for the passed locale. The implementation class MUST NOT add locale-generalisation when resolving the text ("de_DE" => "de" => default).

Specified by:

getText in interface ISimpleTextProvider

Parameters:

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

Returns:

null if no text for the given locale was found.

getTextWithLocaleFallback

@Nullable
public final String getTextWithLocaleFallback(@Nonnull
                                        Locale aContentLocale)

Description copied from interface: ISimpleTextProvider

Get the text specific for the passed locale. The implementation class MUST add locale-generalisation when resolving the text ("de_DE" => "de" => default).

Specified by:

getTextWithLocaleFallback in interface ISimpleTextProvider

Parameters:

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

Returns:

null if no text for the given locale was found.

See Also:

LocaleUtils.getCalculatedLocaleListForResolving(Locale)