@JSFValidator(configExcluded=true) public class DateTimeRangeValidator extends Object implements javax.faces.validator.Validator, javax.faces.component.StateHolder
DateTimeRangeValidator is a Validator that checks
the value of the corresponding component against specified minimum and
maximum dates. The following algorithm is implemented:
null, exit immediately.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
Validator.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.The detail part of faces message which arise during validation can be customised by overriding the message associated with each message id by calling appropriate setter methods.
The methods used for customizing the detail message associated with each id is given below:
Then this message will be used to construct faces message when validation fails based on the above-mentioned algorithm| 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 |
VALIDATOR_ID |
| Constructor and Description |
|---|
DateTimeRangeValidator()
Construct a
Validator with no preconfigured limits. |
DateTimeRangeValidator(Date maximum)
Construct a
Validator with the specified preconfigured
limit. |
DateTimeRangeValidator(Date maximum,
Date minimum)
Construct a
Validator with the specified preconfigured
limits. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o) |
String |
getHintMaximum()
Return custom hint maximum message.
|
String |
getHintMinimum()
Return custom hint minimum message.
|
String |
getHintNotInRange()
Return custom hint notInRange message.
|
Date |
getMaximum()
Return the maximum value to be enforced by this
Validator or null if it has not been
set. |
String |
getMessageDetailMaximum()
Return custom detail error message that was set for creating
FacesMessage,
for cases where input value exceeds the maximum value set. |
String |
getMessageDetailMinimum()
Return custom detail error message that was set for creating
FacesMessage,
for cases where, input value is less than the minimum value set. |
String |
getMessageDetailNotInRange()
Return custom detail error message that was set for creating
FacesMessage,
for cases where, input value exceeds the maximum value and is
less than the minimum value set. |
Date |
getMinimum()
Return the minimum value to be enforced by this
Validator, or null if it has not been
set. |
javax.faces.el.ValueBinding |
getValueBinding(String name)
Deprecated.
|
javax.el.ValueExpression |
getValueExpression(String name)
Return the
ValueExpression used to calculate the value for the
specified attribute name, if any. |
int |
hashCode() |
boolean |
isDisabled()
Return whether it is disabled.
|
boolean |
isTransient() |
void |
restoreState(javax.faces.context.FacesContext context,
Object state) |
Object |
saveState(javax.faces.context.FacesContext context) |
void |
setDisabled(boolean isDisabled)
Return whether it is disabled.
|
void |
setHintMaximum(String hintMaximum)
Custom hint maximum message.
|
void |
setHintMinimum(String hintMinimum)
Custom hint minimum message.
|
void |
setHintNotInRange(String hintNotInRange)
Custom hint notInRange message.
|
void |
setMaximum(Date maximum)
Set the maximum value to be enforced by this
Validator. |
void |
setMessageDetailMaximum(String maximumMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage, when input value exceeds the maximum value set. |
void |
setMessageDetailMinimum(String minimumMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage, when input value is less the set
minimum value. |
void |
setMessageDetailNotInRange(String notInRangeMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage, when input value is not with in the range,
when minimum and maximum is set. |
void |
setMinimum(Date minimum)
Set the minimum value to be enforced by this
Validator. |
void |
setTransient(boolean transientValue) |
void |
setValueBinding(String name,
javax.faces.el.ValueBinding binding)
Deprecated.
|
void |
setValueExpression(String name,
javax.el.ValueExpression expression)
Set the
ValueExpression used to calculate the value for the
specified attribute if any. |
void |
validate(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
Object value) |
public static final String VALIDATOR_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 {0},
{1} and {3} placeholders,
which will be replaced by user input, component label and configured
maximum value.
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 {0},
{1} and {2} placeholders, which will be replaced
by user input, component label and configured minimum value.
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
{0}, {1}, {2} and {3}
placeholders, which will be replaced by user input, component label,
configured minimum value and configured maximum value.
public DateTimeRangeValidator()
Validator with no preconfigured limits.public DateTimeRangeValidator(Date maximum)
Validator with the specified preconfigured
limit.maximum - Maximum value to allow@JSFProperty public Date getMaximum()
Validator or null if it has not been
set.public void setMaximum(Date maximum)
Validator.maximum - The new maximum value@JSFProperty public Date getMinimum()
Validator, or null if it has not been
set.public void setMinimum(Date minimum)
Validator.minimum - The new minimum valuepublic void setMessageDetailMaximum(String maximumMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage, when input value exceeds the maximum value set.
MAXIMUM_MESSAGE_IDmaximumMessageDetail - Custom error message.@JSFProperty public String getMessageDetailMaximum()
Return custom detail error message that was set for creating FacesMessage,
for cases where input value exceeds the maximum value set.
setMessageDetailMaximum(String)public void setMessageDetailMinimum(String minimumMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage, when input value is less the set
minimum value.
MINIMUM_MESSAGE_IDminimumMessageDetail - Custom error message.@JSFProperty public String getMessageDetailMinimum()
Return custom detail error message that was set for creating FacesMessage,
for cases where, input value is less than the minimum value set.
setMessageDetailMinimum(String)public void setMessageDetailNotInRange(String notInRangeMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage, when input value is not with in the range,
when minimum and maximum is set.
NOT_IN_RANGE_MESSAGE_IDnotInRangeMessageDetail - Custom error message.@JSFProperty public String getMessageDetailNotInRange()
Return custom detail error message that was set for creating FacesMessage,
for cases where, input value exceeds the maximum value and is
less than the minimum value set.
setMessageDetailNotInRange(String)public void setHintMaximum(String hintMaximum)
Custom hint maximum message.
Overrides default hint messagehintMaximum - Custom hint message.@JSFProperty(tagExcluded=true) public String getHintMaximum()
Return custom hint maximum message.
setHintMaximum(String)public void setHintMinimum(String hintMinimum)
Custom hint minimum message.
Overrides default hint messagehintMinimum - Custom hint message.@JSFProperty(tagExcluded=true) public String getHintMinimum()
Return custom hint minimum message.
setHintMinimum(String)public void setHintNotInRange(String hintNotInRange)
Custom hint notInRange message.
Overrides default hint messagehintNotInRange - Custom hint message.@JSFProperty(tagExcluded=true) public String getHintNotInRange()
Return custom hint notInRange message.
setHintNotInRange(String)public void validate(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
Object value)
throws javax.faces.validator.ValidatorException
validate in interface javax.faces.validator.ValidatorIllegalArgumentException - if value is not of type
Datejavax.faces.validator.ValidatorExceptionpublic Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHolderpublic void restoreState(javax.faces.context.FacesContext context,
Object state)
restoreState in interface javax.faces.component.StateHolderpublic void setValueExpression(String name, javax.el.ValueExpression expression)
Set the ValueExpression used to calculate the value for the
specified attribute if any.
name - Name of the attribute for which to set a ValueExpressionexpression - The ValueExpression to set, or null
to remove any currently set ValueExpressionNullPointerException - if name
is nullIllegalArgumentException - if name is not a valid
attribute of this converterpublic javax.el.ValueExpression getValueExpression(String name)
Return the ValueExpression used to calculate the value for the
specified attribute name, if any.
name - Name of the attribute or property for which to retrieve a
ValueExpressionNullPointerException - if name
is nullIllegalArgumentException - if name is not a valid
attribute of this converterpublic void setValueBinding(String name, javax.faces.el.ValueBinding binding)
Set the ValueBinding used to calculate the value for the
specified attribute if any.
name - Name of the attribute for which to set a ValueBindingbinding - The ValueBinding to set, or null
to remove any currently set ValueBindingNullPointerException - if name
is nullIllegalArgumentException - if name is not a valid
attribute of this validatorpublic javax.faces.el.ValueBinding getValueBinding(String name)
Return the ValueBinding used to calculate the value for the
specified attribute name, if any.
name - Name of the attribute or property for which to retrieve a
ValueBindingNullPointerException - if name
is nullIllegalArgumentException - if name is not a valid
attribute of this validator@JSFProperty(istransient=true,
tagExcluded=true)
public boolean isTransient()
isTransient in interface javax.faces.component.StateHolderpublic void setTransient(boolean transientValue)
setTransient in interface javax.faces.component.StateHolderpublic void setDisabled(boolean isDisabled)
public boolean isDisabled()
Copyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.