com.blazebit.i18n

Class LocaleUtils

java.lang.Object

com.blazebit.i18n.LocaleUtils

public final class LocaleUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static Locale	getLocale(String string)
static Locale	resolveLocale(Iterable<Locale> preferredLocales, Collection<Locale> supportedLocales, Locale defaultLocale)
static Locale	resolveLocale(Iterable<Locale> preferredLocales, Collection<Locale> supportedLocales, Locale defaultLocale, boolean strictVarianMatching)
static Locale	resolveLocale(Iterator<Locale> preferredLocales, Collection<Locale> supportedLocales, Locale defaultLocale)
static Locale	resolveLocale(Iterator<Locale> preferredLocales, Collection<Locale> supportedLocales, Locale defaultLocale, boolean strictVarianMatching)
static Locale	resolveLocale(Iterator<Locale> preferredLocales, Collection<Locale> supportedLocales, Locale defaultLocale, boolean countryMatching, boolean strictVariantMatching) Resolves the best matching locale from the given set of preferred locales, supported locales and the default locale.

Methods inherited from class java.lang.Object

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

Method Detail

getLocale

public static Locale getLocale(String string)

resolveLocale

public static Locale resolveLocale(Iterable<Locale> preferredLocales,
                                   Collection<Locale> supportedLocales,
                                   Locale defaultLocale)

resolveLocale

public static Locale resolveLocale(Iterable<Locale> preferredLocales,
                                   Collection<Locale> supportedLocales,
                                   Locale defaultLocale,
                                   boolean strictVarianMatching)

resolveLocale

public static Locale resolveLocale(Iterator<Locale> preferredLocales,
                                   Collection<Locale> supportedLocales,
                                   Locale defaultLocale)

resolveLocale

public static Locale resolveLocale(Iterator<Locale> preferredLocales,
                                   Collection<Locale> supportedLocales,
                                   Locale defaultLocale,
                                   boolean strictVarianMatching)

resolveLocale

public static Locale resolveLocale(Iterator<Locale> preferredLocales,
                                   Collection<Locale> supportedLocales,
                                   Locale defaultLocale,
                                   boolean countryMatching,
                                   boolean strictVariantMatching)

Resolves the best matching locale from the given set of preferred locales, supported locales and the default locale. Use ordered collections to get deterministic results and prevent unexpected behavior.

The algorithm for resolving works as follows:

1. If no supported or preferred locales are given, return default locale.
2. Iterate over preferred locales
   1. If a perfect match can be found, return it.
   2. If a supported locale without a variant that matches the language and country of the preferred locale can be found, return it
   3. If strict variants matching is turned off and a supported locale that matches the language and country of the preferred locale can be found, return it
   4. If a supported locale without a variant and country that matches the language of the preferred locale can be found, return it
3. If country matching is turned on, return the first locale of the supported locales that matches the country
4. Return the default locale

Parameters:

preferredLocales - The preferred locales to search for. The order of the locales returned by the iterator represents the preference.

supportedLocales - The available locales to search from. The order of the locales in the collection represents the preference.

defaultLocale - The default locale if no match can be found.

countryMatching - True if country matching should be turned on, otherwise false.

strictVariantMatching - True if a resolved locale may also contain a supported locale that has a different variant than a preferred locale, otherwise false.

Returns:

Returns the best match or the default locale if nothing matches.