Interface Validator<T>
-
- Type Parameters:
T
- The generic type of object value to validate.
- All Superinterfaces:
EventListener
- All Known Implementing Classes:
BeanValidator
,DoubleRangeValidator
,LengthValidator
,LongRangeValidator
,MethodExpressionValidator
,RegexValidator
,RequiredValidator
public interface Validator<T> extends EventListener
A Validator implementation is a class that can perform validation (correctness checks) on a
EditableValueHolder
. Zero or moreValidator
s can be associated with eachEditableValueHolder
in the view, and are called during the Process Validations phase of the request processing lifecycle.Individual
Validator
s should examine the value and component that they are passed, and throw aValidatorException
containing aFacesMessage
, documenting any failures to conform to the required rules.For maximum generality,
Validator
instances may be configurable based on properties of theValidator
implementation class. For example, a range checkValidator
might support configuration of the minimum and maximum values to be used.Validator
implementations must have a zero-arguments public constructor. In addition, if theValidator
class wishes to have configuration property values saved and restored with the view, the implementation must also implementStateHolder
.If the class implementing
Validator
has aResourceDependency
annotation, the action described inResourceDependency
must be taken whenEditableValueHolder.addValidator(jakarta.faces.validator.Validator)
is called. If the class implementingValidator
has aResourceDependencies
annotation, the action described inResourceDependencies
must be taken whenEditableValueHolder.addValidator(jakarta.faces.validator.Validator)
is called.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
validate(FacesContext context, UIComponent component, T value)
-
-
-
Method Detail
-
validate
void validate(FacesContext context, UIComponent component, T value) throws ValidatorException
Perform the correctness checks implemented by this
Validator
against the specifiedUIComponent
. If any violations are found, aValidatorException
will be thrown containing theFacesMessage
describing the failure.For a validator to be fully compliant with Version 2 and later of the specification, it must not fail validation on
null
or empty values unless it is specifically intended to addressnull
or empty values. An application-wide<context-param>
is provided to allow validators designed for Jakarta Faces 1.2 to work with Jakarta Faces 2 and later. Thejakarta.faces.VALIDATE_EMPTY_FIELDS
<context-param>
must be set tofalse
to enable this backwards compatibility behavior.- Parameters:
context
- FacesContext for the request we are processingcomponent
- UIComponent we are checking for correctnessvalue
- the value to validate- Throws:
ValidatorException
- if validation failsNullPointerException
- ifcontext
orcomponent
isnull
-
-