org.jahia.utils

Class LanguageCodeConverters

java.lang.Object

org.jahia.utils.LanguageCodeConverters

public class LanguageCodeConverters
extends Object

Title: Utility class to convert between the different type of language codes encodings.

Description: This class was design to offer conversion tools between various language code encodings into Strings, Locales and other types of objects.

Copyright: Copyright (c) 2002

Company:

Version:

1.0

Author:

Serge Huber.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LanguageCodeConverters.LocaleDisplayNameComparator Comparator implementation that compares locale display names in a certain current locale.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAVA7_LOCALE_TOSTRING
static Pattern	LANGUAGE_PATTERN

Constructor Summary

Constructors

Constructor and Description
LanguageCodeConverters()

Method Summary

Modifier and Type	Method and Description
static List<Locale>	getAvailableBundleLocales()
static List<Locale>	getAvailableBundleLocales(String resourceBundleName, Locale defaultLocale)
static List<Locale>	getAvailableBundleLocalesSorted()
static List<Locale>	getAvailableBundleLocalesSorted(Locale currentLocale)
static LanguageCodeConverters.LocaleDisplayNameComparator	getLocaleDisplayNameComparator(Locale locale)
static Locale	getLocaleFromCode(String code) Converts (alt) string such as en_US, fr_CH_unix, fr, en, _GB, fr__UNIX into Locale objects.
static List<Locale>	getSortedLocaleList(Locale currentLocale)
static boolean	isValidLanguageCode(String languageCode) Tests if the language code is valid or not, according to the Locale.toString() format.
static Locale	languageCodeToLocale(String languageCode) Converts string such as en_US, fr_CH_unix, fr, en, _GB, fr__UNIX into Locale objects.
static Locale	languageTagsToLocale(String languageCode) Converts language tags encoded (RFC 3066) to Locales.
static List<String>	localesToLanguageCodes(List<Locale> locales)
static String	localeToLanguageTag(Locale locale) Returns a language tags encoded (RFC 3066) compliant string from a Java Locale object.
static Locale	resolveLocaleForGuest(javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

LANGUAGE_PATTERN

public static final Pattern LANGUAGE_PATTERN

JAVA7_LOCALE_TOSTRING

public static final String JAVA7_LOCALE_TOSTRING

See Also:

Constant Field Values

Constructor Detail

LanguageCodeConverters

public LanguageCodeConverters()

Method Detail

isValidLanguageCode

public static boolean isValidLanguageCode(String languageCode)

Tests if the language code is valid or not, according to the Locale.toString() format.

Parameters:

languageCode -

Returns:

languageCodeToLocale

public static Locale languageCodeToLocale(String languageCode)

Converts string such as en_US, fr_CH_unix, fr, en, _GB, fr__UNIX into Locale objects. This method is the reverse operation of the Locale.toString() output. So a good test case for this method could be : languageCodeToLocale(Locale.toString()).equals(Locale)

Parameters:

languageCode - the encoded string

Returns:

the resulting Locale object, or the default language code if no language was found.

getLocaleFromCode

public static Locale getLocaleFromCode(String code)

Converts (alt) string such as en_US, fr_CH_unix, fr, en, _GB, fr__UNIX into Locale objects. This method is the reverse operation of the Locale.toString() output. So a good test case for this method could be : languageCodeToLocale(Locale.toString()).equals(Locale)

Parameters:

code - the encoded string

Returns:

the resulting Locale object, or the default language code if no language was found.

languageTagsToLocale

public static Locale languageTagsToLocale(String languageCode)

Converts language tags encoded (RFC 3066) to Locales. Examples of language tags encoding are : en-us, en, en-scouse Warning : this is not entirely RFC 3066 because we cannot convert from 3 characters ISO 639 part 2 to ISO 639 part 1 codes. In the case a 3 characters code is found we return null.

Parameters:

languageCode - the encoded string

Returns:

a Locale corresponding to the encoding.

localeToLanguageTag

public static String localeToLanguageTag(Locale locale)

Returns a language tags encoded (RFC 3066) compliant string from a Java Locale object. Note that Locales without any languages will not be accepted by this method and will return a null String since language tags MUST contain a language

Parameters:

locale - the locale we want to be converted.

Returns:

a String containing the RFC 3066 encoded language information extracted from the tag. If their is no language found in the locale a NULL string is returned instead !

getSortedLocaleList

public static List<Locale> getSortedLocaleList(Locale currentLocale)

resolveLocaleForGuest

public static Locale resolveLocaleForGuest(javax.servlet.http.HttpServletRequest request)

getLocaleDisplayNameComparator

public static LanguageCodeConverters.LocaleDisplayNameComparator getLocaleDisplayNameComparator(Locale locale)

getAvailableBundleLocales

public static List<Locale> getAvailableBundleLocales(String resourceBundleName,
                                                     Locale defaultLocale)

localesToLanguageCodes

public static List<String> localesToLanguageCodes(List<Locale> locales)

getAvailableBundleLocales

public static List<Locale> getAvailableBundleLocales()

getAvailableBundleLocalesSorted

public static List<Locale> getAvailableBundleLocalesSorted(Locale currentLocale)

getAvailableBundleLocalesSorted

public static List<Locale> getAvailableBundleLocalesSorted()