org.josef.web.jsf.util

Class JsfLocaleUtil

java.lang.Object

org.josef.web.jsf.util.JsfLocaleUtil

public final class JsfLocaleUtil
extends Object

Java Server Faces Locale Utility class.

Version:

1.0 $Revision: 5773 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static Locale	getCurrentLocale() Convenience method to get the current locale from the view root.
static Locale	getDefaultLocale() Convenience method to get the default locale.
static List<Locale>	getSupportedLocales() Gets the supported locales.
static List<javax.faces.model.SelectItem>	getSupportedLocalesAsListItems() Gets the supported locales as a List of SelectItem objects so they can be used in a UIComponent that expects it's values to contain objects of type SelectItem.
static boolean	isLocaleSupported(Locale locale) Determines whether the supplied locale is one of the supported locales.
static javax.faces.model.SelectItem	localeToSelectItem(Locale locale, Locale displayLocale) Converts the supplied locale to a SelectItem so that the supplied locale is the value of the SelectItem and the display name of the supplied locale is the label of the SelectItem.

Methods inherited from class java.lang.Object

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

Method Detail

getCurrentLocale

public static Locale getCurrentLocale()

Convenience method to get the current locale from the view root.

Returns:

The current locale from the view root.

getDefaultLocale

public static Locale getDefaultLocale()

Convenience method to get the default locale.

Returns:

The default locale or null when the default locale has not been set explicitly.

isLocaleSupported

public static boolean isLocaleSupported(Locale locale)

Determines whether the supplied locale is one of the supported locales.
A locale is supported when it exists as a supported locale in the Application object.

Parameters:

locale - The locale to check.

Returns:

true When the supplied locale is supported, false when it is not supported.

getSupportedLocales

public static List<Locale> getSupportedLocales()

Gets the supported locales.

Returns:

The supported locales.
This list is possibly empty but it is never null!

getSupportedLocalesAsListItems

public static List<javax.faces.model.SelectItem> getSupportedLocalesAsListItems()

Gets the supported locales as a List of SelectItem objects so they can be used in a UIComponent that expects it's values to contain objects of type SelectItem.
The texts in the SelectItem will also be localized, according to the current locale.

Returns:

The supported locales.
This list is possibly empty but it is never null!

localeToSelectItem

public static javax.faces.model.SelectItem localeToSelectItem(Locale locale,
                                                              Locale displayLocale)

Converts the supplied locale to a SelectItem so that the supplied locale is the value of the SelectItem and the display name of the supplied locale is the label of the SelectItem.

Parameters:

locale - The locale to convert.

displayLocale - The locale to display the supplied locale in.

Returns:

A SelectItem representing the supplied locale.

Throws:

NullPointerException - When the supplied locale is null.