public class LongRangeValidator extends Object implements Validator, StateHolder
LongRangeValidator is a Validator
that checks
the value of the corresponding component against specified minimum and
maximum values. The following algorithm is implemented:
null
, exit immediately.ValidatorException
containing a
TYPE_MESSAGE_ID message.maximum
and minimum
property
has been configured on this Validator
, check the component
value against both limits. If the component value is not within
this specified range, throw a ValidatorException
containing a
NOT_IN_RANGE_MESSAGE_ID
message.maximum
property has been configured on this
Validator
, check the component value against
this limit. If the component value is greater than the
specified maximum, throw a ValidatorException
containing a
MAXIMUM_MESSAGE_ID message.minimum
property has been configured on this
Validator
, check the component value against
this limit. If the component value is less than the
specified minimum, throw a ValidatorException
containing a
MINIMUM_MESSAGE_ID message.For all of the above cases that cause a ValidatorException
to be thrown, if there are parameters to the message that match up
with validator parameters, the values of these parameters must be
converted using the Converter
registered in the application
under the converter id javax.faces.Number
. This allows
the values to be localized according to the current
Locale
.
Modifier and Type | Field and Description |
---|---|
static String |
MAXIMUM_MESSAGE_ID
The message identifier of the
FacesMessage to be created if
the maximum value check fails. |
static String |
MINIMUM_MESSAGE_ID
The message identifier of the
FacesMessage to be created if
the minimum value check fails. |
static String |
NOT_IN_RANGE_MESSAGE_ID
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. |
static String |
TYPE_MESSAGE_ID
The message identifier of the
FacesMessage to be created if
the current value of this component is not of the correct type. |
static String |
VALIDATOR_ID
The standard converter id for this converter.
|
Constructor and Description |
---|
LongRangeValidator()
Construct a
Validator with no preconfigured limits. |
LongRangeValidator(long maximum)
Construct a
Validator with the specified preconfigured
limit. |
LongRangeValidator(long maximum,
long minimum)
Construct a
Validator with the specified preconfigured
limits. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object otherObj) |
long |
getMaximum()
Return the maximum value to be enforced by this
Validator . |
long |
getMinimum()
Return the minimum value to be enforced by this
Validator . |
int |
hashCode() |
boolean |
isTransient()
If true, the Object implementing this interface must not
participate in state saving or restoring.
|
void |
restoreState(FacesContext context,
Object state)
Perform any processing required to restore the state from the
entries in the state Object.
|
Object |
saveState(FacesContext context)
Gets the state of the instance as a
Serializable Object. |
void |
setMaximum(long maximum)
Set the maximum value to be enforced by this
Validator . |
void |
setMinimum(long minimum)
Set the minimum value to be enforced by this
Validator . |
void |
setTransient(boolean transientValue)
Denotes whether or not the Object implementing this interface must
or must not participate in state saving or restoring.
|
void |
validate(FacesContext context,
UIComponent component,
Object value)
Perform the correctness checks implemented by this
Validator against the specified UIComponent . |
public static final String VALIDATOR_ID
The standard converter id for this converter.
public static final String MAXIMUM_MESSAGE_ID
The message identifier of the FacesMessage
to be created if
the maximum value check fails. The message format string for
this message may optionally include the following placeholders:
{0}
replaced by the configured maximum value.{1}
replaced by a String
whose value
is the label of the input component that produced this message.public static final String MINIMUM_MESSAGE_ID
The message identifier of the FacesMessage
to be created if
the minimum value check fails. The message format string for
this message may optionally include the following placeholders:
{0}
replaced by the configured minimum value.{1}
replaced by a String
whose value
is the label of the input component that produced this message.public static final String NOT_IN_RANGE_MESSAGE_ID
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 the following
placeholders:
{0}
replaced by the configured minimum value.{1}
replaced by the configured maximum value.{2}
replaced by a String
whose value
is the label of the input component that produced this message.public static final String TYPE_MESSAGE_ID
The message identifier of the FacesMessage
to be created if
the current value of this component is not of the correct type.
The message format string for this message may
optionally include a {0}
placeholder that will be
replaced by a String
whose value is the label of
the input component that produced this message.
public LongRangeValidator()
Construct a Validator
with no preconfigured limits.
public LongRangeValidator(long maximum)
Construct a Validator
with the specified preconfigured
limit.
maximum
- Maximum value to allowpublic LongRangeValidator(long maximum, long minimum)
Construct a Validator
with the specified preconfigured
limits.
maximum
- Maximum value to allowminimum
- Minimum value to allowpublic long getMaximum()
Return the maximum value to be enforced by this Validator
.
public void setMaximum(long maximum)
Set the maximum value to be enforced by this Validator
.
maximum
- The new maximum valuepublic long getMinimum()
Return the minimum value to be enforced by this Validator
.
public void setMinimum(long minimum)
Set the minimum value to be enforced by this Validator
.
minimum
- The new minimum valuepublic void validate(FacesContext context, UIComponent component, Object value) throws ValidatorException
Validator
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.
validate
in interface Validator
context
- FacesContext for the request we are processingcomponent
- UIComponent we are checking for correctnessvalue
- the value to validateNullPointerException
- if context
or component
is null
ValidatorException
- if validation failspublic Object saveState(FacesContext context)
StateHolder
Gets the state of the instance as a
Serializable
Object.
If the class that implements this interface has references to
instances that implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.)
this method must call the StateHolder.saveState(javax.faces.context.FacesContext)
method on all those
instances as well. This method must not save the state
of children and facets. That is done via the StateManager
This method must not alter the state of the implementing object. In other words, after executing this code:
Object state = component.saveState(facesContext);
component
should be the same as before executing
it.
The return from this method must be Serializable
saveState
in interface StateHolder
public void restoreState(FacesContext context, Object state)
StateHolder
Perform any processing required to restore the state from the entries in the state Object.
If the class that implements this interface has references to
instances that also implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.)
this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
method on all those
instances as well.
restoreState
in interface StateHolder
public boolean isTransient()
StateHolder
If true, the Object implementing this interface must not participate in state saving or restoring.
isTransient
in interface StateHolder
public void setTransient(boolean transientValue)
StateHolder
Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
setTransient
in interface StateHolder
transientValue
- boolean pass true
if this Object
will participate in state saving or restoring, otherwise
pass false
.Copyright © 2018 JBoss by Red Hat. All rights reserved.