Class RegexValidator
- java.lang.Object
-
- jakarta.faces.validator.RegexValidator
-
- All Implemented Interfaces:
PartialStateHolder
,StateHolder
,Validator
,EventListener
public class RegexValidator extends Object implements Validator, PartialStateHolder
A Validator that checks against a Regular Expression (which is the pattern property). The pattern must resolve to a String that follows the java.util.regex standards.
- Since:
- 2.0
-
-
Field Summary
Fields Modifier and Type Field Description static String
MATCH_EXCEPTION_MESSAGE_ID
The message identifier of theFacesMessage
to be created if the act of matching the value against the pattern returned fromgetPattern()
fails because of aPatternSyntaxException
.static String
NOT_MATCHED_MESSAGE_ID
The message identifier of theFacesMessage
to be created if the act of matching the value against the pattern returned fromgetPattern()
fails because the value does not match the pattern.static String
PATTERN_NOT_SET_MESSAGE_ID
The message identifier of theFacesMessage
to be created if the value returned fromgetPattern()
isnull
or the empty String.static String
VALIDATOR_ID
The standard converter id for this converter.
-
Constructor Summary
Constructors Constructor Description RegexValidator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearInitialState()
Reset the PartialStateHolder to a non-delta tracking state.String
getPattern()
Return theValueExpression
that yields the regular expression pattern when evaluated.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
setPattern(String pattern)
The Regular Expression property to validate against.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)
Validate a String against a regular expression pattern.
-
-
-
Field Detail
-
VALIDATOR_ID
public static final String VALIDATOR_ID
The standard converter id for this converter.
- See Also:
- Constant Field Values
-
PATTERN_NOT_SET_MESSAGE_ID
public static final String PATTERN_NOT_SET_MESSAGE_ID
The message identifier of the
FacesMessage
to be created if the value returned fromgetPattern()
isnull
or the empty String.- See Also:
- Constant Field Values
-
NOT_MATCHED_MESSAGE_ID
public static final String NOT_MATCHED_MESSAGE_ID
The message identifier of the
FacesMessage
to be created if the act of matching the value against the pattern returned fromgetPattern()
fails because the value does not match the pattern.- See Also:
- Constant Field Values
-
MATCH_EXCEPTION_MESSAGE_ID
public static final String MATCH_EXCEPTION_MESSAGE_ID
The message identifier of the
FacesMessage
to be created if the act of matching the value against the pattern returned fromgetPattern()
fails because of aPatternSyntaxException
.- See Also:
- Constant Field Values
-
-
Method Detail
-
setPattern
public void setPattern(String pattern)
The Regular Expression property to validate against.
- Parameters:
pattern
- a regular expression pattern
-
getPattern
public String getPattern()
Return the
ValueExpression
that yields the regular expression pattern when evaluated.- Returns:
- the pattern
-
validate
public void validate(FacesContext context, UIComponent component, Object value)
Validate a String against a regular expression pattern. The full regex pattern must be matched in order to pass the validation.
- 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
-
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
-
-