Package com.helger.commons.text

Class AbstractReadOnlyMapBasedMultilingualText

java.lang.Object

com.helger.commons.text.AbstractHasText

com.helger.commons.text.AbstractReadOnlyMapBasedMultilingualText

All Implemented Interfaces:

IHasText, IHasTextWithArgs, IMultilingualText, Serializable

Direct Known Subclasses:

AbstractMapBasedMultilingualText, ReadOnlyMultilingualText

public abstract class AbstractReadOnlyMapBasedMultilingualText
extends AbstractHasText
implements IMultilingualText, Serializable

A Map based implementation of IMultilingualText that does not provide writing methods to the outside and is only to be used as a non-abstract base class.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractReadOnlyMapBasedMultilingualText()
protected	AbstractReadOnlyMapBasedMultilingualText(ICommonsOrderedMap<Locale,String> aMapToUse)	Protected constructor that specifies the underlying Map to use.

Method Summary

Modifier and Type	Method	Description
boolean	containsLocaleWithFallback(Locale aContentLocale)	Check if the passed locale is directly or by fallback contained.
boolean	equals(Object o)
int	hashCode()
protected void	internalAddText(Locale aContentLocale, String sValue)
protected void	internalAddText(Map.Entry<Locale,String> aEntry)
protected Locale	internalGetLocaleToUseWithFallback(Locale aContentLocale)	Determine the locale to use.
protected String	internalGetText(Locale aContentLocale)	Main text resolving.
protected void	internalSetText(Locale aContentLocale, String sValue)
static boolean	isPerformConsistencyChecks()
static void	setPerformConsistencyChecks(boolean bPerformConsistencyChecks)	Enable or disable the internal consistency checks.
ICommonsOrderedMap<Locale,String>	texts()
String	toString()

Methods inherited from class com.helger.commons.text.AbstractHasText

getText

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.text.IHasText

getAsHasDisplayText, getText

Methods inherited from interface com.helger.commons.text.IHasTextWithArgs

getAsHasDisplayTextWithArgs, getTextWithArgs, getTextWithArgs

Constructor Detail

AbstractReadOnlyMapBasedMultilingualText

protected AbstractReadOnlyMapBasedMultilingualText()

AbstractReadOnlyMapBasedMultilingualText

protected AbstractReadOnlyMapBasedMultilingualText(@Nonnull
                                                   ICommonsOrderedMap<Locale,String> aMapToUse)

Protected constructor that specifies the underlying Map to use. Use this constructor to e.g. provide a concurrent HashMap or similar.

Parameters:

aMapToUse - The map to use. Must not be null and must be writable.

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

protected final void internalAddText(@Nonnull
                                     Map.Entry<Locale,String> aEntry)

internalAddText

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

internalSetText

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

internalGetText

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

Description copied from class: AbstractHasText

Main text resolving. Get the text in the passed locale.

Specified by:

internalGetText in class AbstractHasText

Parameters:

aContentLocale - Locale to use. This is the locale resolved internally. Never null.

Returns:

null if no such text present in the passed locale

internalGetLocaleToUseWithFallback

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

Description copied from class: AbstractHasText

Determine the locale to use.

Overrides:

internalGetLocaleToUseWithFallback in class AbstractHasText

Parameters:

aContentLocale - Requested locale. Never null.

Returns:

The locale to use. May be null.

containsLocaleWithFallback

public final boolean containsLocaleWithFallback(@Nullable
                                                Locale aContentLocale)

Description copied from interface: IMultilingualText

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 IMultilingualText

Parameters:

aContentLocale - The locale to check. May be null.

Returns:

true if the locale is contained, false if not.

texts

@Nonnull
@ReturnsMutableObject
public final ICommonsOrderedMap<Locale,String> texts()

Specified by:

texts in interface IMultilingualText

Returns:

The Locale to text map. Never null.

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