org.apache.myfaces.commons.converter
Class EnumConverter
java.lang.Object
   org.apache.myfaces.commons.converter.EnumConverter
org.apache.myfaces.commons.converter.EnumConverter
- All Implemented Interfaces: 
- javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.convert.Converter
- @JSFConverter(name="mcc:convertEnum",
              tagClass="org.apache.myfaces.commons.converter.ConvertEnumTag",
              tagHandler="org.apache.myfaces.commons.converter.ConvertEnumTagHandler",
              serialuidtag="3864584277821896141L")
public class EnumConverter
- extends java.lang.Object- implements javax.faces.convert.Converter, javax.faces.component.PartialStateHolder
Converts a Java 5 Enum.
 
 see Javadoc of JSF Specification
- Author:
- Stan Silvert
 
 
| Method Summary | 
|  void | clearInitialState()
 | 
|  java.lang.Object | getAsObject(javax.faces.context.FacesContext facesContext,
            javax.faces.component.UIComponent uiComponent,
            java.lang.String value)
 | 
|  java.lang.String | getAsString(javax.faces.context.FacesContext facesContext,
            javax.faces.component.UIComponent uiComponent,
            java.lang.Object value)
 | 
|  java.lang.Class | getTargetClass()The enum class to be used for this converter as reference
 | 
|  boolean | initialStateMarked()
 | 
|  boolean | isTransient()
 | 
|  void | markInitialState()
 | 
|  void | restoreState(javax.faces.context.FacesContext context,
             java.lang.Object state)
 | 
|  java.lang.Object | saveState(javax.faces.context.FacesContext context)
 | 
|  void | setTargetClass(java.lang.Class targetClass)
 | 
|  void | setTransient(boolean newTransientValue)
 | 
 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
CONVERTER_ID
public static final java.lang.String CONVERTER_ID
- See Also:
- Constant Field Values
ENUM_ID
public static final java.lang.String ENUM_ID
- See Also:
- Constant Field Values
ENUM_NO_CLASS_ID
public static final java.lang.String ENUM_NO_CLASS_ID
- See Also:
- Constant Field Values
ENUM_NO_ENUM_CLASS
public static final java.lang.String ENUM_NO_ENUM_CLASS
- See Also:
- Constant Field Values
SEPARATOR
public static final java.lang.String SEPARATOR
- See Also:
- Constant Field Values
EnumConverter
public EnumConverter()
- Creates a new instance of EnumConverter
 
EnumConverter
public EnumConverter(java.lang.Class targetClass)
getAsString
public java.lang.String getAsString(javax.faces.context.FacesContext facesContext,
                                    javax.faces.component.UIComponent uiComponent,
                                    java.lang.Object value)
                             throws javax.faces.convert.ConverterException
- 
- Specified by:
- getAsStringin interface- javax.faces.convert.Converter
 
- 
- Throws:
- javax.faces.convert.ConverterException
 
getAsObject
public java.lang.Object getAsObject(javax.faces.context.FacesContext facesContext,
                                    javax.faces.component.UIComponent uiComponent,
                                    java.lang.String value)
                             throws javax.faces.convert.ConverterException
- 
- Specified by:
- getAsObjectin interface- javax.faces.convert.Converter
 
- 
- Throws:
- javax.faces.convert.ConverterException
 
restoreState
public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
- 
- Specified by:
- restoreStatein interface- javax.faces.component.StateHolder
 
- 
 
saveState
public java.lang.Object saveState(javax.faces.context.FacesContext context)
- 
- Specified by:
- saveStatein interface- javax.faces.component.StateHolder
 
- 
 
setTransient
public void setTransient(boolean newTransientValue)
- 
- Specified by:
- setTransientin interface- javax.faces.component.StateHolder
 
- 
 
isTransient
public boolean isTransient()
- 
- Specified by:
- isTransientin interface- javax.faces.component.StateHolder
 
- 
 
getTargetClass
@JSFProperty
public java.lang.Class getTargetClass()
- The enum class to be used for this converter as reference
 
- 
 
- 
 
setTargetClass
public void setTargetClass(java.lang.Class targetClass)
- 
 
- 
 
clearInitialState
public void clearInitialState()
- 
- Specified by:
- clearInitialStatein interface- javax.faces.component.PartialStateHolder
 
- 
 
initialStateMarked
public boolean initialStateMarked()
- 
- Specified by:
- initialStateMarkedin interface- javax.faces.component.PartialStateHolder
 
- 
 
markInitialState
public void markInitialState()
- 
- Specified by:
- markInitialStatein interface- javax.faces.component.PartialStateHolder
 
- 
 
Copyright © 2007-2012 The Apache Software Foundation. All Rights Reserved.