org.josef.web.jsf.converter

Class EnumConverter

java.lang.Object

org.josef.web.jsf.converter.EnumConverter

All Implemented Interfaces:

Serializable, javax.faces.convert.Converter

public class EnumConverter
extends Object
implements javax.faces.convert.Converter, Serializable

Converter for objects of type Enum that are backed by a properties file.
This converter converts the localized description of an Enum to an actual Enum and vice versa. As expected, this converter can only do its work reliably when the localized description is unique (case insensitive) within the enumerated set.
You probably don't want to register this converter as a generic converter in faces-config.xml. Instead, perform conversion on a per field basis, using the converter attribute. Here is an example from the Cars.xhtml page.

<h:outputText value="#{car.carDetail.color}" converter="enumConverter}"/>

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnumConverter()

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, String stringEnum) Converts the supplied stringEnum to an object of type Enum.
String	getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object enumeratedValue) Converts the supplied enumeratedValue to a localized String consisting of the localized description of the enumerated value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumConverter

public EnumConverter()

Method Detail

getAsObject

public Object getAsObject(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent component,
                          String stringEnum)

Converts the supplied stringEnum to an object of type Enum.

Specified by:

getAsObject in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the enumerated value.

stringEnum - The enum in String format to convert to an Enum.

Returns:

The supplied stringEnum converted to an Enum or null when no enumerated value with the supplied stringEnum exists.

getAsString

public String getAsString(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent component,
                          Object enumeratedValue)

Converts the supplied enumeratedValue to a localized String consisting of the localized description of the enumerated value.

Specified by:

getAsString in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the enumerated value.

enumeratedValue - The enum to convert to a localized String.

Returns:

The localized String value of the supplied enumeratedValue.
Null is returned when either the supplied enumeratedValue is null or not of type Enum.