Module jakarta.faces

Package jakarta.faces.validator

Annotation Interface FacesValidator

@Retention(RUNTIME)
@Target({TYPE,FIELD,METHOD,PARAMETER})
@Inherited
@Qualifier
public @interface FacesValidator

The presence of this annotation on a class automatically registers the class with the runtime as a Validator. The value of the value() attribute is taken to be the validator-id and the fully qualified class name of the class to which this annotation is attached is taken to be the validator-class. The implementation must guarantee that for each class annotated with * FacesValidator, 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, Application.addValidator(java.lang.String,java.lang.String) is called, passing the derived validator-id as the first argument and the derived validator-class as the second argument. The implementation must guarantee that all such calls to addValidator() happen during application startup time and before any requests are serviced.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FacesValidator.Literal	Supports inline instantiation of the FacesValidator qualifier.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	isDefault	If true, the validator id for this annotation is added to the list of default validators by a call to Application.addDefaultValidatorId(java.lang.String).
boolean	managed	The value of this annotation attribute is taken to be an indicator that flags whether or not the given validator is a CDI managed validator.
String	value	The value of this annotation attribute is taken to be the validator-id with which instances of this class of component can be instantiated by calling Application.createValidator(java.lang.String).

Element Details

value

String value

The value of this annotation attribute is taken to be the validator-id with which instances of this class of component can be instantiated by calling Application.createValidator(java.lang.String). If no value is specified, or the value is null, the value is taken to be the return of calling getSimpleName on the class to which this annotation is attached and lowercasing the first character. If more than one validator with this derived name is found, the results are undefined.

Returns:

the validator-id

Default:

""

isDefault

boolean isDefault

If true, the validator id for this annotation is added to the list of default validators by a call to Application.addDefaultValidatorId(java.lang.String).

Returns:

whether or not this is a default validator

Default:

false

managed

boolean managed

The value of this annotation attribute is taken to be an indicator that flags whether or not the given validator is a CDI managed validator.

Returns:

true if CDI managed, false otherwise.

Default:

false