public class LengthValidator extends java.lang.Object implements Validator, PartialStateHolder
LengthValidator is a Validator
that checks the number of
characters in the String representation of the value of the associated component. The following algorithm is
implemented:
toString()
method.maximum
property has been configured on this Validator
, check the length of the
converted String against this limit. If the String length is larger than the specified maximum, throw a
ValidatorException
containing a a MAXIMUM_MESSAGE_ID message.minimum
property has been configured on this Validator
, check the length of the
converted String against this limit. If the String length is less than the specified minimum, throw a
ValidatorException
containing a 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 jakarta.faces.Number
. This allows
the values to be localized according to the current Locale
.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MAXIMUM_MESSAGE_ID
The message identifier of the
FacesMessage to be created if the maximum length
check fails. |
static java.lang.String |
MINIMUM_MESSAGE_ID
The message identifier of the
FacesMessage to be created if the minimum length
check fails. |
static java.lang.String |
VALIDATOR_ID
The standard validator id for this validator.
|
NOT_IN_RANGE_MESSAGE_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 |
---|---|
void |
clearInitialState()
Reset the PartialStateHolder to a non-delta tracking state. |
boolean |
equals(java.lang.Object otherObj) |
int |
getMaximum()
Return the maximum length to be enforced by this
Validator , or 0 if the maximum has not been
set. |
int |
getMinimum()
Return the minimum length to be enforced by this
Validator , or 0 if the minimum has not been
set. |
int |
hashCode() |
boolean |
initialStateMarked()
Return |
boolean |
isTransient()
If true, the Object implementing this interface must not participate in state saving or restoring.
|
void |
markInitialState()
The runtime must ensure that the |
void |
restoreState(FacesContext context,
java.lang.Object state)
Perform any processing required to restore the state from the entries
in the state Object.
|
java.lang.Object |
saveState(FacesContext context)
Gets the state of the instance as a
Serializable Object. |
void |
setMaximum(int maximum)
Set the maximum length to be enforced by this
Validator . |
void |
setMinimum(int minimum)
Set the minimum length 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,
java.lang.Object value)
|
public static final java.lang.String VALIDATOR_ID
The standard validator id for this validator.
public static final java.lang.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 the following placeholders:
{0}
replaced by the configured maximum length.{1}
replaced by a String
whose value is the label of the input component that produced
this message.public static final java.lang.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 the following placeholders:
{0}
replaced by the configured minimum length.{1}
replaced by a String
whose value is the label of the input component that produced
this message.public LengthValidator()
Construct a Validator
with no preconfigured limits.
public LengthValidator(int maximum)
Construct a Validator
with the specified preconfigured limit.
maximum
- Maximum value to allowpublic LengthValidator(int maximum, int minimum)
Construct a Validator
with the specified preconfigured limits.
maximum
- Maximum value to allowminimum
- Minimum value to allowpublic int getMaximum()
Return the maximum length to be enforced by this Validator
, or 0
if the maximum has not been
set.
public void setMaximum(int maximum)
Set the maximum length to be enforced by this Validator
.
maximum
- The new maximum valuepublic int getMinimum()
Return the minimum length to be enforced by this Validator
, or 0
if the minimum has not been
set.
public void setMinimum(int minimum)
Set the minimum length to be enforced by this Validator
.
minimum
- The new minimum valuepublic void validate(FacesContext context, UIComponent component, java.lang.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.
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 address null
or empty values. An
application-wide <context-param>
is provided to allow validators designed for Jakarta Server Faces
1.2 to work with Jakarta Server Faces 2 and later. The jakarta.faces.VALIDATE_EMPTY_FIELDS
<context-param>
must be set to false
to enable this backwards compatibility behavior.
validate
in interface Validator
context
- FacesContext for the request we are processingcomponent
- UIComponent we are checking for correctnessvalue
- the value to validatejava.lang.NullPointerException
- if context
or component
is null
ValidatorException
- if validation failspublic boolean equals(java.lang.Object otherObj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.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(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 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
context
- the Faces context.public void restoreState(FacesContext context, java.lang.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(jakarta.faces.context.FacesContext, java.lang.Object)
method on all those instances as well.
If the state
argument is null
, take no action and return.
restoreState
in interface StateHolder
context
- the Faces context.state
- the state.public boolean isTransient()
StateHolder
If true, the Object implementing this interface must not participate in state saving or restoring.
isTransient
in interface StateHolder
true
if transient, false
otherwise.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
not participate in state saving or restoring, otherwise pass false
.public void markInitialState()
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 that PartialStateHolder.initialStateMarked()
returns true
from the time markInitialState()
is
called until PartialStateHolder.clearInitialState()
is called, after which time initialStateMarked()
must return
false
. Also, during the time that the instance returns true
from
initialStateMarked()
, the implementation must return only the state that has changed in its
implementation of StateHolder.saveState(jakarta.faces.context.FacesContext)
.
markInitialState
in interface PartialStateHolder
public boolean initialStateMarked()
PartialStateHolder
Return true
if delta state changes are being tracked, otherwise false
initialStateMarked
in interface PartialStateHolder
true
if the initial state is marked, false
otherwise.public void clearInitialState()
PartialStateHolder
Reset the PartialStateHolder to a non-delta tracking state.
clearInitialState
in interface PartialStateHolder