The presence of this annotation on a class automatically registers the
class with the runtime as a Converter. The value of the value attribute is taken to be
converter-id, the value of the forClass attribute is taken to be converter-for-class and
the fully qualified class name of the class to which this annotation is attached is taken to be the
converter-class. The implementation must guarantee that for each class annotated with
FacesConverter, found with the algorithm in
section 11.4 "Annotations that correspond to and may take the place of entries in the Application Configuration Resources" of the Jakarta Faces Specification Document,
the proper variant of
Application.addConverter() is called. If converter-id is not the empty string,
jakarta.faces.application.Application#addConverter(java.lang.String, java.lang.String) is called, passing the
derived converter-id as the first argument and the derived converter-class as the second argument.
If converter-id is the empty string,
jakarta.faces.application.Application#addConverter(java.lang.Class, java.lang.String) is called, passing the
converter-for-class as the first argument and the derived converter-class as the second argument.
The implementation must guarantee that all such calls to addConverter() happen during application
startup time and before any requests are serviced.
The preceding text contains an important subtlety which application users should understand. It is not possible to
use a single @FacesConverter annotation to register a single Converter implementation both in the
by-class and the by-converter-id data structures. One way to achieve this result is to put the actual
converter logic in an abstract base class, without a @FacesConverter annotation, and derive two sub-classes,
each with a @FacesConverter annotation. One sub-class has a value attribute but no forClass
attribute, and the other sub-class has the converse.
Please see the ViewDeclarationLanguage documentation for <h:selectManyListBox> for another important subtlety regarding converters and collections.
| Modifier and Type | Class and Description |
|---|---|
| public static class | FacesConverter.Literal
Supports inline instantiation of the |
| Modifier and Type | Method and Description |
|---|---|
| public Class | Returns: the class
The value of this annotation attribute is taken to be the converter-for-class with which instances of this
class of converter can be instantiated by calling
|
| public boolean | Returns: whether or not this converter is managed by CDIThe value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter. |
| public String | Returns: the converter-id
The value of this annotation attribute is taken to be the converter-id with which instances of this class of
converter can be instantiated by calling
|
| forClass | back to summary |
|---|---|
| public Class
The value of this annotation attribute is taken to be the converter-for-class with which instances of this
class of converter can be instantiated by calling
| |
| managed | back to summary |
|---|---|
| public boolean managed() The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter.
| |
| value | back to summary |
|---|---|
| public String value()
The value of this annotation attribute is taken to be the converter-id with which instances of this class of
converter can be instantiated by calling
| |
Supports inline instantiation of the FacesConverter qualifier.
| Modifier and Type | Field and Description |
|---|---|
| private final Class | |
| public static final FacesConverter. | INSTANCE
Instance of the |
| private final boolean | |
| private static final long | |
| private final String |
| Access | Constructor and Description |
|---|---|
| private |
| Modifier and Type | Method and Description |
|---|---|
| public Class | forClass()
Implements jakarta.
The value of this annotation attribute is taken to be the converter-for-class with which instances of this
class of converter can be instantiated by calling
|
| public boolean | managed()
Implements jakarta. The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter. |
| public static FacesConverter. | |
| public String | value()
Implements jakarta.
The value of this annotation attribute is taken to be the converter-id with which instances of this class of
converter can be instantiated by calling
|
| forClass | back to summary |
|---|---|
| private final Class<T> forClass | |
| INSTANCE | back to summary |
|---|---|
| public static final FacesConverter. Instance of the | |
| managed | back to summary |
|---|---|
| private final boolean managed | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides jakarta. | |
| value | back to summary |
|---|---|
| private final String value | |
| Literal | back to summary |
|---|---|
| private Literal(String value, Class<T> forClass, boolean managed) | |
| forClass | back to summary |
|---|---|
| public Class Implements jakarta. Doc from jakarta.
The value of this annotation attribute is taken to be the converter-for-class with which instances of this
class of converter can be instantiated by calling
| |
| managed | back to summary |
|---|---|
| public boolean managed() Implements jakarta. Doc from jakarta. The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter.
| |
| of | back to summary |
|---|---|
| public static FacesConverter. | |
| value | back to summary |
|---|---|
| public String value() Implements jakarta. Doc from jakarta.
The value of this annotation attribute is taken to be the converter-id with which instances of this class of
converter can be instantiated by calling
| |