|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Converter
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 UIViewRoot
of the current FacesContext, unless the
Converter maintains its own Locale as part
of its state.
If the class implementing
Converter has a ResourceDependency annotation, the action
described in ResourceDependency must be taken when
ValueHolder.setConverter(javax.faces.convert.Converter) is called.
If the class implementing Converter has a ResourceDependencies annotation, the
action described in ResourceDependencies must be taken
when ValueHolder.setConverter(javax.faces.convert.Converter) is called.
| Method Summary | |
|---|---|
java.lang.Object |
getAsObject(FacesContext context,
UIComponent component,
java.lang.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. |
java.lang.String |
getAsString(FacesContext context,
UIComponent component,
java.lang.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. |
| Method Detail |
|---|
java.lang.Object getAsObject(FacesContext context,
UIComponent component,
java.lang.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.
context - FacesContext for the request being processedcomponent - UIComponent with which this model object
value is associatedvalue - String value to be converted (may be null)
null if the value to convert is null,
otherwise the result of the conversion
ConverterException - if conversion cannot be successfully
performed
java.lang.NullPointerException - if context or
component is null
java.lang.String getAsString(FacesContext context,
UIComponent component,
java.lang.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.
context - FacesContext for the request being processedcomponent - UIComponent with which this model object
value is associatedvalue - Model object value to be converted
(may be null)
null,
otherwise the result of the conversion
ConverterException - if conversion cannot be successfully
performed
java.lang.NullPointerException - if context or
component is null
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24