Class DoubleRangeValidator
- java.lang.Object
-
- jakarta.faces.validator.DoubleRangeValidator
-
- All Implemented Interfaces:
PartialStateHolder
,StateHolder
,Validator
,EventListener
public class DoubleRangeValidator extends Object implements Validator, PartialStateHolder
DoubleRangeValidator is a
Validator
that checks the value of the corresponding component against specified minimum and maximum values. The following algorithm is implemented:- If the passed value is
null
, exit immediately. - If the current component value is not a floating point type, or a String that is convertible to double, throw a
ValidatorException
containing a TYPE_MESSAGE_ID message. - If both a
maximum
andminimum
property has been configured on thisValidator
, check the component value against both limits. If the component value is not within this specified range, throw aValidatorException
containing aNOT_IN_RANGE_MESSAGE_ID
message. - If a
maximum
property has been configured on thisValidator
, check the component value against this limit. If the component value is greater than the specified maximum, throw aValidatorException
containing a MAXIMUM_MESSAGE_ID message. - If a
minimum
property has been configured on thisValidator
, check the component value against this limit. If the component value is less than the specified minimum, throw aValidatorException
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 theConverter
registered in the application under the converter idjakarta.faces.Number
. This allows the values to be localized according to the currentLocale
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
MAXIMUM_MESSAGE_ID
The message identifier of theFacesMessage
to be created if the maximum value check fails.static String
MINIMUM_MESSAGE_ID
The message identifier of theFacesMessage
to be created if the minimum value check fails.static String
NOT_IN_RANGE_MESSAGE_ID
The message identifier of theFacesMessage
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 theFacesMessage
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 Summary
Constructors Constructor Description DoubleRangeValidator()
Construct aValidator
with no preconfigured limits.DoubleRangeValidator(double maximum)
Construct aValidator
with the specified preconfigured limit.DoubleRangeValidator(double maximum, double minimum)
Construct aValidator
with the specified preconfigured limits.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearInitialState()
Reset the PartialStateHolder to a non-delta tracking state.boolean
equals(Object otherObj)
Overrides the default equals method to take the minimum and maximum into account when comparing DoubleRangeValidator instances.double
getMaximum()
Return the maximum value to be enforced by thisValidator
orDouble.MAX_VALUE
if it has not been set.double
getMinimum()
Return the minimum value to be enforced by thisValidator
, orDouble.MIN_VALUE
if it has not been set.int
hashCode()
Overrides the default hash code method to take the minimum and maximum into account when generating the hash code.boolean
initialStateMarked()
Returntrue
if delta state changes are being tracked, otherwisefalse
boolean
isTransient()
If true, the Object implementing this interface must not participate in state saving or restoring.void
markInitialState()
The runtime must ensure that thePartialStateHolder.markInitialState()
method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state.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 aSerializable
Object.void
setMaximum(double maximum)
Set the maximum value to be enforced by thisValidator
.void
setMinimum(double minimum)
Set the minimum value to be enforced by thisValidator
.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)
-
-
-
Field Detail
-
VALIDATOR_ID
public static final String VALIDATOR_ID
The standard converter id for this converter.
- See Also:
- Constant Field Values
-
MAXIMUM_MESSAGE_ID
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 aString
whose value is the label of the input component that produced this message.
- See Also:
- Constant Field Values
-
MINIMUM_MESSAGE_ID
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 aString
whose value is the label of the input component that produced this message.
- See Also:
- Constant Field Values
-
NOT_IN_RANGE_MESSAGE_ID
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 aString
whose value is the label of the input component that produced this message.
- See Also:
- Constant Field Values
-
TYPE_MESSAGE_ID
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 aString
whose value is the label of the input component that produced this message.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DoubleRangeValidator
public DoubleRangeValidator()
Construct a
Validator
with no preconfigured limits.
-
DoubleRangeValidator
public DoubleRangeValidator(double maximum)
Construct a
Validator
with the specified preconfigured limit.- Parameters:
maximum
- Maximum value to allow
-
DoubleRangeValidator
public DoubleRangeValidator(double maximum, double minimum)
Construct a
Validator
with the specified preconfigured limits.- Parameters:
maximum
- Maximum value to allowminimum
- Minimum value to allow
-
-
Method Detail
-
getMaximum
public double getMaximum()
Return the maximum value to be enforced by this
Validator
orDouble.MAX_VALUE
if it has not been set.- Returns:
- the maximum
-
setMaximum
public void setMaximum(double maximum)
Set the maximum value to be enforced by this
Validator
.- Parameters:
maximum
- The new maximum value
-
getMinimum
public double getMinimum()
Return the minimum value to be enforced by this
Validator
, orDouble.MIN_VALUE
if it has not been set.- Returns:
- the minimum value
-
setMinimum
public void setMinimum(double minimum)
Set the minimum value to be enforced by this
Validator
.- Parameters:
minimum
- The new minimum value
-
validate
public void validate(FacesContext context, UIComponent component, Object value) throws ValidatorException
Description copied from interface:Validator
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.- Specified by:
validate
in interfaceValidator
- Parameters:
context
- FacesContext for the request we are processingcomponent
- UIComponent we are checking for correctnessvalue
- the value to validate- Throws:
NullPointerException
- ifcontext
orcomponent
isnull
ValidatorException
- if validation fails
-
equals
public boolean equals(Object otherObj)
Overrides the default equals method to take the minimum and maximum into account when comparing DoubleRangeValidator instances.
-
hashCode
public int hashCode()
Overrides the default hash code method to take the minimum and maximum into account when generating the hash code.
-
saveState
public Object saveState(FacesContext context)
Description copied from interface: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 theStateHolder.saveState(jakarta.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 theStateManager
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
- Specified by:
saveState
in interfaceStateHolder
- Parameters:
context
- the Faces context.- Returns:
- the saved state.
-
restoreState
public void restoreState(FacesContext context, Object state)
Description copied from interface: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 theStateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object)
method on all those instances as well.If the
state
argument isnull
, take no action and return.- Specified by:
restoreState
in interfaceStateHolder
- Parameters:
context
- the Faces context.state
- the state.
-
isTransient
public boolean isTransient()
Description copied from interface:StateHolder
If true, the Object implementing this interface must not participate in state saving or restoring.
- Specified by:
isTransient
in interfaceStateHolder
- Returns:
true
if transient,false
otherwise.
-
setTransient
public void setTransient(boolean transientValue)
Description copied from interface:StateHolder
Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
- Specified by:
setTransient
in interfaceStateHolder
- Parameters:
transientValue
- boolean passtrue
if this Object will not participate in state saving or restoring, otherwise passfalse
.
-
markInitialState
public void markInitialState()
Description copied from interface:PartialStateHolder
The runtime must ensure that the
PartialStateHolder.markInitialState()
method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure thatPartialStateHolder.initialStateMarked()
returnstrue
from the timemarkInitialState()
is called untilPartialStateHolder.clearInitialState()
is called, after which timeinitialStateMarked()
must returnfalse
. Also, during the time that the instance returnstrue
frominitialStateMarked()
, the implementation must return only the state that has changed in its implementation ofStateHolder.saveState(jakarta.faces.context.FacesContext)
.- Specified by:
markInitialState
in interfacePartialStateHolder
-
initialStateMarked
public boolean initialStateMarked()
Description copied from interface:PartialStateHolder
Return
true
if delta state changes are being tracked, otherwisefalse
- Specified by:
initialStateMarked
in interfacePartialStateHolder
- Returns:
true
if the initial state is marked,false
otherwise.
-
clearInitialState
public void clearInitialState()
Description copied from interface:PartialStateHolder
Reset the PartialStateHolder to a non-delta tracking state.
- Specified by:
clearInitialState
in interfacePartialStateHolder
-
-