public interface Validator extends EventListener
A Validator implementation is a class that can
perform validation (correctness checks) on a EditableValueHolder
. Zero or more
Validator
s can be associated with each
EditableValueHolder
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 a ValidatorException
containing a FacesMessage
, documenting
any failures to conform to the required rules.
For maximum generality, Validator
instances may be
configurable based on properties of the Validator
implementation
class. For example, a range check Validator
might support
configuration of the minimum and maximum values to be used.
Validator
implementations must have a zero-arguments
public constructor. In addition, if the Validator
class
wishes to have configuration property values saved and restored with
the view, the implementation must also implement StateHolder
.
Modifier and Type | Field and Description |
---|---|
static String |
NOT_IN_RANGE_MESSAGE_ID
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
validate(FacesContext context,
UIComponent component,
Object value)
Perform the correctness checks implemented by this
Validator against the specified UIComponent . |
static final String NOT_IN_RANGE_MESSAGE_ID
DoubleRangeValidator.NOT_IN_RANGE_MESSAGE_ID
or
LongRangeValidator.NOT_IN_RANGE_MESSAGE_ID
instead.The message identifier of the FacesMessage
to be created if
the maximum or minimum value check fails, and both the maximum
and minimum values for this validator have been set. The message
format string for this message may optionally include a
{0}
placeholder, which will be replaced by the
configured minimum value, and a {1}
placeholder,
which will be replaced by the configured maximum value.
void validate(FacesContext context, UIComponent component, Object value) throws ValidatorException
Perform the correctness checks implemented by this
Validator
against the specified UIComponent
.
If any violations are found, a ValidatorException
will be thrown containing the FacesMessage
describing
the failure.
context
- FacesContext for the request we are processingcomponent
- UIComponent we are checking for correctnessvalue
- the value to validateValidatorException
- if validation failsNullPointerException
- if context
or component
is null
Copyright © 2018 JBoss by Red Hat. All rights reserved.