com.phloc.commons.text.impl

Class TextProvider

java.lang.Object

com.phloc.commons.text.impl.AbstractSimpleTextProvider

com.phloc.commons.text.impl.AbstractTextProvider

com.phloc.commons.text.impl.TextProvider

All Implemented Interfaces:

IHasLocales, IHasSize, IReadonlyMultiLingualText, ISimpleMultiLingualText, ISimpleTextProvider, ITextProvider, Serializable

Direct Known Subclasses:

MultiLingualText, ReadonlyMultiLingualText

public class TextProvider
extends AbstractTextProvider
implements IReadonlyMultiLingualText

An in-memory implementation of the ITextProvider interface.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Locale	DE German locale used
static Locale	EN English locale used

Constructor Summary

Constructors

Constructor and Description
TextProvider()

Method Summary

Methods

Modifier and Type	Method and Description
TextProvider	addTextDE(String sDE)
TextProvider	addTextEN(String sEN)
boolean	containsLocale(Locale aLocale) Check if the passed locale is directly contained.
boolean	containsLocaleWithFallback(Locale aContentLocale) Check if the passed locale is directly or by fallback contained.
static TextProvider	create_DE_EN(String sDE, String sEN)
static TextProvider	create_DE(String sDE)
static TextProvider	create_EN(String sEN)
boolean	equals(Object o)
Set<Locale>	getAllLocales()
int	getLocaleCount()
Map<Locale,String>	getMap()
int	hashCode()
protected TextProvider	internalAddText(Locale aContentLocale, String sValue)
protected EChange	internalClear()
Set<Locale>	internalGetAllLocales()
protected Locale	internalGetLocaleToUseWithFallback(Locale aContentLocale) Determine the locale to use.
protected Map<Locale,String>	internalGetMap()
protected String	internalGetText(Locale aContentLocale) Main text resolving
protected EChange	internalRemoveText(Locale aLocale)
protected TextProvider	internalSetText(Locale aContentLocale, String sValue)
boolean	isEmpty()
static boolean	isPerformConsistencyChecks()
static void	setPerformConsistencyChecks(boolean bPerformConsistencyChecks) Enable or disable the internal consistency checks.
int	size()
String	toString()

Methods inherited from class com.phloc.commons.text.impl.AbstractTextProvider

getTextWithArgs, getTextWithLocaleFallbackAndArgs

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

getText, getTextWithLocaleFallback

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.phloc.commons.text.ITextProvider

getTextWithArgs, getTextWithLocaleFallbackAndArgs

Methods inherited from interface com.phloc.commons.text.ISimpleTextProvider

getText, getTextWithLocaleFallback

Field Detail

DE

public static final Locale DE

German locale used

EN

public static final Locale EN

English locale used

Constructor Detail

TextProvider

public TextProvider()

Method Detail

setPerformConsistencyChecks

public static void setPerformConsistencyChecks(boolean bPerformConsistencyChecks)

Enable or disable the internal consistency checks.

Parameters:

bPerformConsistencyChecks - true to enable them, false to disable them.

isPerformConsistencyChecks

public static boolean isPerformConsistencyChecks()

Returns:

true if consistency checks are enabled, false if not. The default value is GlobalDebug.isDebugMode().

internalAddText

@Nonnull
protected final TextProvider internalAddText(@Nonnull
                                   Locale aContentLocale,
                                   @Nonnull
                                   String sValue)

internalSetText

@Nonnull
protected final TextProvider internalSetText(@Nonnull
                                   Locale aContentLocale,
                                   @Nullable
                                   String sValue)

internalRemoveText

@Nonnull
protected final EChange internalRemoveText(@Nullable
                                 Locale aLocale)

internalClear

@Nonnull
protected final EChange internalClear()

addTextDE

@Nonnull
public final TextProvider addTextDE(@Nonnull
                             String sDE)

addTextEN

@Nonnull
public final TextProvider addTextEN(@Nonnull
                             String sEN)

internalGetMap

@Nonnull
@ReturnsMutableObject(reason="Internal use only")
protected final Map<Locale,String> internalGetMap()

internalGetLocaleToUseWithFallback

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

Description copied from class: AbstractSimpleTextProvider

Determine the locale to use.

Specified by:

internalGetLocaleToUseWithFallback in class AbstractSimpleTextProvider

Parameters:

aContentLocale - Requested locale

Returns:

The locale to use. May be null.

internalGetText

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

Description copied from class: AbstractSimpleTextProvider

Main text resolving

Specified by:

internalGetText in class AbstractSimpleTextProvider

Parameters:

aContentLocale - locale to use

Returns:

null if no such text present in the passed locale

internalGetAllLocales

@Nonnull
@ReturnsMutableObject(reason="Internal use only")
public final Set<Locale> internalGetAllLocales()

getAllLocales

@Nonnull
@ReturnsMutableCopy
public final Set<Locale> getAllLocales()

Specified by:

getAllLocales in interface IHasLocales

Returns:

The locales of this object. May not be null.

getLocaleCount

@Nonnegative
public final int getLocaleCount()

Specified by:

getLocaleCount in interface IHasLocales

Returns:

The number of contained locales. Always ≥ 0.

containsLocale

public final boolean containsLocale(@Nullable
                     Locale aLocale)

Description copied from interface: IHasLocales

Check if the passed locale is directly contained.

Specified by:

containsLocale in interface IHasLocales

Parameters:

aLocale - The locale to check. May be null.

Returns:

true if the locale is directly contained, false if not.

containsLocaleWithFallback

public final boolean containsLocaleWithFallback(@Nullable
                                 Locale aContentLocale)

Description copied from interface: IHasLocales

Check if the passed locale is directly or by fallback contained. The implementation class MUST add locale-generalisation when resolving the text ("de_DE" => "de" => default).

Specified by:

containsLocaleWithFallback in interface IHasLocales

Parameters:

aContentLocale - The locale to check. May be null.

Returns:

true if the locale is contained, false if not.

getMap

@Nonnull
@ReturnsMutableCopy
public final Map<Locale,String> getMap()

Specified by:

getMap in interface IReadonlyMultiLingualText

Returns:

A map over all contained locale/text pairs. Never null .

size

@Nonnegative
public final int size()

Specified by:

size in interface IHasSize

Returns:

The number of contained elements. Always ≥ 0.

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface IHasSize

Returns:

true if no items are present, false if at least a single item is present.

See Also:

IHasSize.size()

equals

@OverridingMethodsMustInvokeSuper
public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

@OverridingMethodsMustInvokeSuper
public int hashCode()

Overrides:

hashCode in class Object

toString

@OverridingMethodsMustInvokeSuper
public String toString()

Overrides:

toString in class Object

create_DE

@Nonnull
public static TextProvider create_DE(@Nonnull
                             String sDE)

create_EN

@Nonnull
public static TextProvider create_EN(@Nonnull
                             String sEN)

create_DE_EN

@Nonnull
public static TextProvider create_DE_EN(@Nonnull
                                String sDE,
                                @Nonnull
                                String sEN)