com.phloc.commons

Interface IHasLocales

All Known Subinterfaces:

IMultiLingualText, IReadonlyMultiLingualText, ISimpleMultiLingualText

All Known Implementing Classes:

MultiLingualText, MultiLingualTextThreadSafe, ReadonlyMultiLingualText, TextProvider

public interface IHasLocales

Base interface for objects having zero or more locales.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsLocale(Locale aLocale) Check if the passed locale is directly contained.
boolean	containsLocaleWithFallback(Locale aLocale) Check if the passed locale is directly or by fallback contained.
Collection<Locale>	getAllLocales()
int	getLocaleCount()

Method Detail

getAllLocales

@Nonnull
Collection<Locale> getAllLocales()

Returns:

The locales of this object. May not be null.

getLocaleCount

@Nonnegative
int getLocaleCount()

Returns:

The number of contained locales. Always ≥ 0.

containsLocale

boolean containsLocale(@Nullable
                     Locale aLocale)

Check if the passed locale is directly contained.

Parameters:

aLocale - The locale to check. May be null.

Returns:

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

containsLocaleWithFallback

boolean containsLocaleWithFallback(@Nullable
                                 Locale aLocale)

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

Parameters:

aLocale - The locale to check. May be null.

Returns:

true if the locale is contained, false if not.