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.
Modifier and Type | Field and Description |
---|---|
static 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 from getPattern() fails because of a
PatternSyntaxException . |
static 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 from getPattern() fails because the value does not match the
pattern. |
static String |
PATTERN_NOT_SET_MESSAGE_ID
The message identifier of the
FacesMessage to be created if the value
returned from getPattern() is null or the
empty String. |
static String |
VALIDATOR_ID
The standard converter id for this converter.
|
NOT_IN_RANGE_MESSAGE_ID
Constructor and Description |
---|
RegexValidator() |
Modifier and Type | Method and Description |
---|---|
void |
clearInitialState()
Reset the PartialStateHolder to a non-delta tracking state. |
String |
getPattern()
Return the
ValueExpression that yields the
regular expression pattern when evaluated. |
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,
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 a
Serializable 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.
|
public static final String VALIDATOR_ID
The standard converter id for this converter.
public static final String PATTERN_NOT_SET_MESSAGE_ID
The message identifier of the FacesMessage
to be created if the value
returned from getPattern()
is null
or the
empty String.
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 from getPattern()
fails because the value does not match the
pattern.
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 from getPattern()
fails because of a
PatternSyntaxException
.
public void setPattern(String pattern)
The Regular Expression property to validate against.
pattern
- a regular expression patternpublic String getPattern()
Return the ValueExpression
that yields the
regular expression pattern when evaluated.
public void validate(FacesContext context, UIComponent component, Object value)
validate
in interface Validator
context
- FacesContext for the request we are processingcomponent
- UIComponent we are checking for correctnessvalue
- the value to validateNullPointerException
- if context
or component
is null
ValidatorException
- if validation failspublic 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(javax.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
public void restoreState(FacesContext context, 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(javax.faces.context.FacesContext, java.lang.Object)
method on all those
instances as well.
restoreState
in interface StateHolder
public boolean isTransient()
StateHolder
If true, the Object implementing this interface must not participate in state saving or restoring.
isTransient
in interface StateHolder
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 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(javax.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
public void clearInitialState()
PartialStateHolder
Reset the PartialStateHolder to a non-delta tracking state.
clearInitialState
in interface PartialStateHolder
Copyright © 2018 JBoss by Red Hat. All rights reserved.