com.helger.commons.text

Class AbstractReadOnlyMapBasedMultilingualText

java.lang.Object

com.helger.commons.text.AbstractHasText

com.helger.commons.text.AbstractHasTextWithArgs

com.helger.commons.text.AbstractReadOnlyMapBasedMultilingualText

All Implemented Interfaces:

IHasSize, IHasLocales, IHasText, IHasTextWithArgs, IMultilingualText, Serializable

Direct Known Subclasses:

AbstractMapBasedMultilingualText, ReadOnlyMultilingualText

public abstract class AbstractReadOnlyMapBasedMultilingualText
extends AbstractHasTextWithArgs
implements IMultilingualText

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 and Description
	AbstractReadOnlyMapBasedMultilingualText()
protected	AbstractReadOnlyMapBasedMultilingualText(Map<Locale,String> aMapToUse) Protected constructor that specifies the underlying Map to use.

Method Summary

Modifier and Type	Method and Description
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.
boolean	equals(Object o)
Set<Locale>	getAllLocales()
Map<Locale,String>	getAllTexts()
int	getLocaleCount()
int	getSize()
int	hashCode()
protected void	internalAddText(Locale aContentLocale, String sValue)
protected void	internalAddText(Map.Entry<Locale,String> aEntry)
protected void	internalClear()
protected 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 aContentLocale)
protected void	internalSetText(Locale aContentLocale, String sValue)
boolean	isEmpty()
static boolean	isPerformConsistencyChecks()
static void	setPerformConsistencyChecks(boolean bPerformConsistencyChecks) Enable or disable the internal consistency checks.
String	toString()

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

getTextWithArgs, getTextWithArgs

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

getTextWithArgs, getTextWithArgs

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

getText

Constructor Detail

AbstractReadOnlyMapBasedMultilingualText

public AbstractReadOnlyMapBasedMultilingualText()

AbstractReadOnlyMapBasedMultilingualText

protected AbstractReadOnlyMapBasedMultilingualText(@Nonnull
                                                   Map<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)

internalRemoveText

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

internalClear

protected final void internalClear()

internalGetMap

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

internalGetLocaleToUseWithFallback

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

Description copied from class: AbstractHasText

Determine the locale to use.

Specified by:

internalGetLocaleToUseWithFallback in class AbstractHasText

Parameters:

aContentLocale - Requested locale. Never null.

Returns:

The locale to use. May be null.

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

internalGetAllLocales

@Nonnull
 @ReturnsMutableObject(value="Internal use only")
protected 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.

getAllTexts

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

Specified by:

getAllTexts in interface IMultilingualText

Returns:

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

getSize

@Nonnegative
public final int getSize()

Specified by:

getSize 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.getSize()

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