public class LengthValidator
extends javax.faces.validator.LengthValidator
Implementation for length of java.lang.String
values.
Modifier and Type | Field and Description |
---|---|
static String |
EXACT_MESSAGE_ID
The message identifier of the
FacesMessage
to be created if the maximum and minimum lengths are the same,
and the length check fails, and both
the maximum and minimum values for this validator have been set. |
static String |
MAXIMUM_MESSAGE_ID
The message identifier of the
FacesMessage
to be created if the maximum length check fails. |
static String |
MINIMUM_MESSAGE_ID
The message identifier of the
FacesMessage
to be created if the minimum length check fails. |
static String |
NOT_IN_RANGE_MESSAGE_ID
The message identifier of the
FacesMessage
to be created if the maximum or minimum length check fails, and both
the maximum and minimum lengths for this validator have been set. |
static String |
VALIDATOR_ID |
Constructor and Description |
---|
LengthValidator()
Construct a
Validator with no preconfigured limits. |
LengthValidator(int maximum)
Construct a
Validator with the specified preconfigured
limit. |
LengthValidator(int maximum,
int minimum)
Construct a
Validator with the specified preconfigured
limits. |
Modifier and Type | Method and Description |
---|---|
String |
getHintExact()
Return custom hint exact message.
|
String |
getHintMaximum()
Return custom hint maximum message.
|
String |
getHintMinimum()
Return custom hint minimum message.
|
String |
getHintNotInRange()
Return custom hint notInRange message.
|
int |
getMaximum()
Return the maximum length to be enforced by this
Validator or null if it has not been
set. |
String |
getMessageDetailExact()
Return custom detail error message that was set for creating
FacesMessage ,
for cases where the maximum and minimum lengths are the same, and
the input length does not match. |
String |
getMessageDetailMaximum()
Return custom detail error message that was set for creating
FacesMessage ,
for cases where input length exceeds the maximum length set. |
String |
getMessageDetailMinimum()
Return custom detail error message that was set for creating
FacesMessage ,
for cases where, input length is less than the minimum length set. |
String |
getMessageDetailNotInRange()
Return custom detail error message that was set for creating
FacesMessage ,
for cases where, input length exceeds the maximum length and is
less than the minimum length set. |
int |
getMinimum()
Return the minimum length 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. |
protected boolean |
isMaximumSet() |
protected boolean |
isMinimumSet() |
boolean |
isTransient() |
void |
restoreState(javax.faces.context.FacesContext context,
Object state) |
Object |
saveState(javax.faces.context.FacesContext context) |
void |
setHintExact(String hintExact)
Custom hint exact message.
|
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(int maximum)
Set the maximum length to be enforced by this
Validator . |
void |
setMessageDetailExact(String exactMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage ,
for cases where the maximum and minimum lengths are the same, and
the input length does not match. |
void |
setMessageDetailMaximum(String maximumMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage , when input length exceeds the maximum length set. |
void |
setMessageDetailMinimum(String minimumMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage , when input length is less the set
minimum length. |
void |
setMessageDetailNotInRange(String notInRangeMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage , when input length is not with in the range,
when minimum and maximum is set. |
void |
setMinimum(int minimum)
Set the minimum length 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 length 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 length.
public static final String MINIMUM_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the minimum length 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 length.
public static final String NOT_IN_RANGE_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the maximum or minimum length check fails, and both
the maximum and minimum lengths 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 length and configured maximum length.
public static final String EXACT_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the maximum and minimum lengths are the same,
and the length 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}
placeholders, which will be replaced by user input, component label,
configured minimum/maximum length.
public LengthValidator()
Validator
with no preconfigured limits.public LengthValidator(int maximum)
Validator
with the specified preconfigured
limit.maximum
- Maximum length to allowpublic LengthValidator(int maximum, int minimum)
Validator
with the specified preconfigured
limits.maximum
- Maximum length to allowminimum
- Minimum length to allowpublic int getMaximum()
Validator
or null if it has not been
set.getMaximum
in class javax.faces.validator.LengthValidator
public void setMaximum(int maximum)
Validator
.setMaximum
in class javax.faces.validator.LengthValidator
maximum
- The new maximum lengthpublic int getMinimum()
Validator
, or null if it has not been
set.getMinimum
in class javax.faces.validator.LengthValidator
public void setMinimum(int minimum)
Validator
.setMinimum
in class javax.faces.validator.LengthValidator
minimum
- The new minimum lengthpublic void setMessageDetailMaximum(String maximumMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage
, when input length exceeds the maximum length set.
MAXIMUM_MESSAGE_ID
maximumMessageDetail
- Custom error message.public String getMessageDetailMaximum()
Return custom detail error message that was set for creating FacesMessage
,
for cases where input length exceeds the maximum
length set.
setMessageDetailMaximum(String)
public void setMessageDetailMinimum(String minimumMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage
, when input length is less the set
minimum
length.
MINIMUM_MESSAGE_ID
minimumMessageDetail
- Custom error message.public String getMessageDetailMinimum()
Return custom detail error message that was set for creating FacesMessage
,
for cases where, input length is less than the minimum
length set.
setMessageDetailMinimum(String)
public void setMessageDetailNotInRange(String notInRangeMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage
, when input length is not with in the range,
when minimum
and maximum
is set.
NOT_IN_RANGE_MESSAGE_ID
notInRangeMessageDetail
- Custom error message.public String getMessageDetailNotInRange()
Return custom detail error message that was set for creating FacesMessage
,
for cases where, input length exceeds the maximum
length and is
less than the minimum
length set.
setMessageDetailNotInRange(String)
public void setMessageDetailExact(String exactMessageDetail)
Custom error message to be used, for creating detail part of the
FacesMessage
,
for cases where the maximum and minimum lengths are the same, and
the input length does not match.
Overrides detail message identified by message id EXACT_MESSAGE_ID
exactMessageDetail
- Custom error message.public String getMessageDetailExact()
Return custom detail error message that was set for creating FacesMessage
,
for cases where the maximum and minimum lengths are the same, and
the input length does not match.
setMessageDetailExact(String)
public void setHintMaximum(String hintMaximum)
Custom hint maximum message.
Overrides default hint messagehintMaximum
- Custom hint message.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.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.public String getHintNotInRange()
Return custom hint notInRange message.
setHintNotInRange(java.lang.String)
public void setHintExact(String hintExact)
Custom hint exact message.
Overrides default hint messagehintExact
- Custom hint message.public String getHintExact()
Return custom hint exact message.
setHintExact(java.lang.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.Validator
validate
in class javax.faces.validator.LengthValidator
javax.faces.validator.ValidatorException
public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.validator.LengthValidator
public void restoreState(javax.faces.context.FacesContext context, Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.validator.LengthValidator
public 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 ValueExpression
expression
- The ValueExpression
to set, or null
to remove any currently set ValueExpression
NullPointerException
- if name
is null
IllegalArgumentException
- 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
ValueExpression
NullPointerException
- if name
is null
IllegalArgumentException
- 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 ValueBinding
binding
- The ValueBinding
to set, or null
to remove any currently set ValueBinding
NullPointerException
- if name
is null
IllegalArgumentException
- 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
ValueBinding
NullPointerException
- if name
is null
IllegalArgumentException
- if name
is not a valid
attribute of this validatorpublic boolean isTransient()
isTransient
in interface javax.faces.component.StateHolder
isTransient
in class javax.faces.validator.LengthValidator
public void setTransient(boolean transientValue)
setTransient
in interface javax.faces.component.StateHolder
setTransient
in class javax.faces.validator.LengthValidator
protected boolean isMaximumSet()
protected boolean isMinimumSet()
Copyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.