Home » Mojarra-2.0.1 » javax » faces » convert » [javadoc | source]
javax.faces.convert
public interface: Converter [javadoc | source]

All Known Implementing Classes:
    EnumConverter, ShortConverter, ByteConverter, BooleanConverter, BigIntegerConverter, NumberConverter, IntegerConverter, FloatConverter, DoubleConverter, CharacterConverter, LongConverter, DateTimeConverter, BigDecimalConverter

Converter is an interface describing a Java class that can perform Object-to-String and String-to-Object conversions between model data objects and a String representation of those objects that is suitable for rendering.

Converter implementations must have a zero-arguments public constructor. In addition, if the Converter class wishes to have configuration property values saved and restored with the component tree, the implementation must also implement StateHolder .

Starting with version 1.2 of the specification, an exception to the above zero-arguments constructor requirement has been introduced. If a converter has a single argument constructor that takes a Class instance and the Class of the data to be converted is known at converter instantiation time, this constructor must be used to instantiate the converter instead of the zero-argument version. This enables the per-class conversion of Java enumerated types.

If any Converter implementation requires a java.util.Locale to perform its job, it must obtain that Locale from the javax.faces.component.UIViewRoot of the current FacesContext , unless the Converter maintains its own Locale as part of its state.

If the class implementing Converter has a javax.faces.application.ResourceDependency annotation, the action described in ResourceDependency must be taken when javax.faces.component.ValueHolder#setConverter is called. If the class implementing Converter has a javax.faces.application.ResourceDependencies annotation, the action described in ResourceDependencies must be taken when javax.faces.component.ValueHolder#setConverter is called.

Method from javax.faces.convert.Converter Summary:
getAsObject,   getAsString
Method from javax.faces.convert.Converter Detail:
 public Object getAsObject(FacesContext context,
    UIComponent component,
    String value)

    Convert the specified string value, which is associated with the specified UIComponent , into a model data object that is appropriate for being stored during the Apply Request Values phase of the request processing lifecycle.

 public String getAsString(FacesContext context,
    UIComponent component,
    Object value)

    Convert the specified model object value, which is associated with the specified UIComponent , into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle.