org.josef.web.jsf.util

Class JsfSelectItemsFromEnumsUtil

java.lang.Object

org.josef.web.jsf.util.JsfSelectItemsFromEnumsUtil

public final class JsfSelectItemsFromEnumsUtil
extends Object

Java Server Faces Utility class that aids in creating SelectItems from Enumerations.

Version:

1.0 $Revision: 5773 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static <E extends Enum<E>> List<javax.faces.model.SelectItem>	enumSetToSelectItems(EnumSet<E> enumSet) Converts the supplied enumSet, to a List of non localized SelectItem objects.
static <E extends Enum<E>> List<javax.faces.model.SelectItem>	enumSetToSelectItems(EnumSet<E> enumSet, Locale locale) Converts the supplied enumSet, to a List of localized SelectItem objects.
static <E extends Enum<E>> List<javax.faces.model.SelectItem>	enumsToSelectItems(Class<E> enumClass) Converts the supplied enumClass, to a List of non localized SelectItem objects.
static <E extends Enum<E>> List<javax.faces.model.SelectItem>	enumsToSelectItems(Class<E> enumClass, Locale locale) Converts the supplied enumClass, to a List of localized SelectItem objects.

Methods inherited from class java.lang.Object

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

Method Detail

enumsToSelectItems

public static <E extends Enum<E>> List<javax.faces.model.SelectItem> enumsToSelectItems(Class<E> enumClass)

Converts the supplied enumClass, to a List of non localized SelectItem objects.
Each SelectItem will have a value consisting of the enumerated constant and a label consisting of the toString() representation of the enumerated constant.

Type Parameters:

E - The type of the enumeration.

Parameters:

enumClass - The enumerated type to convert.

Returns:

A List of SelectItem objects corresponding to the enumerated constants in the supplied enumClass.

Throws:

NullPointerException - When the supplied enumClass is null.

enumsToSelectItems

public static <E extends Enum<E>> List<javax.faces.model.SelectItem> enumsToSelectItems(Class<E> enumClass,
                                                                                        Locale locale)

Converts the supplied enumClass, to a List of localized SelectItem objects.
Each SelectItem will have a value consisting of the enumerated constant and a label consisting of the localized String representation of the enumerated constant.

Type Parameters:

E - The type of the enumeration.

Parameters:

enumClass - The enumerated type to convert.
This may also be a LocalizableEnumeration.

locale - The locale to create the properly translated labels.
When null, the default locale will be used for the translation of the labels.

Returns:

A List of SelectItem objects corresponding to the enumerated constants in the supplied enumClass.

Throws:

NullPointerException - When the supplied enumClass is null.

See Also:

CEnumeration.getDescription(Enum, Locale)

enumSetToSelectItems

public static <E extends Enum<E>> List<javax.faces.model.SelectItem> enumSetToSelectItems(EnumSet<E> enumSet)

Converts the supplied enumSet, to a List of non localized SelectItem objects.
Each SelectItem will have a value consisting of the enumerated constant and a label consisting of the toString() representation of the enumerated constant.

Type Parameters:

E - The type of the enumeration.

Parameters:

enumSet - The EnumSet to convert.

Returns:

A List of SelectItem objects corresponding to the enumerated constants in the supplied enumSet.

Throws:

NullPointerException - When the supplied enumSet is null.

enumSetToSelectItems

public static <E extends Enum<E>> List<javax.faces.model.SelectItem> enumSetToSelectItems(EnumSet<E> enumSet,
                                                                                          Locale locale)

Converts the supplied enumSet, to a List of localized SelectItem objects.
Each SelectItem will have a value consisting of the enumerated constant and a label consisting of the localized String representation of the enumerated constant.

Type Parameters:

E - The type of the enumeration.

Parameters:

enumSet - The EnumSet to convert to SelectItems.
This may also be a LocalizableEnumeration.

locale - The locale to create the properly translated labels.
When null, the default locale will be used for the translation of the labels.

Returns:

A List of SelectItem objects corresponding to the enumerated constants in the supplied enumSet.

Throws:

NullPointerException - When the supplied enumSet is null.

See Also:

CEnumeration.getDescription(Enum, Locale)