EE4J 10.0.0 · jakarta.faces.validator.RegexValidator

Field Summary

Modifier and Type	Field and Description
private boolean	initialState
public static final String	MATCH_EXCEPTION_MESSAGE_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the act of matching the value against the pattern returned from `getPattern` fails because of a `PatternSyntaxException`.
public static final String	NOT_MATCHED_MESSAGE_ID The message identifier of the `jakarta.faces.application.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	PATTERN_NOT_SET_MESSAGE_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the value returned from `getPattern` is `null` or the empty String.
private String	regex
private boolean	transientValue
public static final String	VALIDATOR_ID The standard converter id for this converter.

Constructor Summary

Access	Constructor and Description
public	RegexValidator()

Method Summary

Modifier and Type	Method and Description
public void	clearInitialState() Implements jakarta.faces.component.PartialStateHolder.clearInitialState. Reset the PartialStateHolder to a non-delta tracking state.
public String	Returns: the pattern getPattern() Return the `ValueExpression` that yields the regular expression pattern when evaluated.
public boolean	initialStateMarked() Implements jakarta.faces.component.PartialStateHolder.initialStateMarked. Return `true` if delta state changes are being tracked, otherwise `false`
public boolean	isTransient() Implements jakarta.faces.component.StateHolder.isTransient. If true, the Object implementing this interface must not participate in state saving or restoring.
public void	markInitialState() Implements jakarta.faces.component.PartialStateHolder.markInitialState. The runtime must ensure that the `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.
public void	restoreState(FacesContext the Faces context. context, Object the state. state) Implements jakarta.faces.component.StateHolder.restoreState. Perform any processing required to restore the state from the entries in the state Object.
public Object	saveState(FacesContext the Faces context. context) Implements jakarta.faces.component.StateHolder.saveState. Gets the state of the instance as a `Serializable` Object.
public void	setPattern(String a regular expression pattern pattern) The Regular Expression property to validate against.
public void	setTransient(boolean boolean pass `true` if this Object will not participate in state saving or restoring, otherwise pass `false`. transientValue) Implements jakarta.faces.component.StateHolder.setTransient. Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
public void	validate(FacesContext FacesContext for the request we are processing context, UIComponent UIComponent we are checking for correctness component, Object the value to validate value) Implements jakarta.faces.validator.Validator.validate. Validate a String against a regular expression pattern.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

initialState	back to summary
private boolean initialState

MATCH_EXCEPTION_MESSAGE_ID	back to summary
public static final String MATCH_EXCEPTION_MESSAGE_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the act of matching the value against the pattern returned from `getPattern` fails because of a `PatternSyntaxException`.

NOT_MATCHED_MESSAGE_ID	back to summary
public static final String NOT_MATCHED_MESSAGE_ID The message identifier of the `jakarta.faces.application.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.

PATTERN_NOT_SET_MESSAGE_ID	back to summary
public static final String PATTERN_NOT_SET_MESSAGE_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the value returned from `getPattern` is `null` or the empty String.

regex	back to summary
private String regex

transientValue	back to summary
private boolean transientValue

VALIDATOR_ID	back to summary
public static final String VALIDATOR_ID The standard converter id for this converter.

Constructor Detail

RegexValidator	back to summary
public RegexValidator()

Method Detail

clearInitialState	back to summary
public void clearInitialState() Implements jakarta.faces.component.PartialStateHolder.clearInitialState. Doc from jakarta.faces.component.PartialStateHolder.clearInitialState. Reset the PartialStateHolder to a non-delta tracking state. Annotations @Override

clearInitialState

back to summary

public void clearInitialState()

Implements jakarta.faces.component.PartialStateHolder.clearInitialState.

Doc from jakarta.faces.component.PartialStateHolder.clearInitialState.

Reset the PartialStateHolder to a non-delta tracking state.

Annotations

@Override

getPattern back to summary

getPattern	back to summary
public String getPattern() Return the `ValueExpression` that yields the regular expression pattern when evaluated. Returns:String the pattern

public String getPattern()

Return the ValueExpression that yields the regular expression pattern when evaluated.

Returns:String: the pattern

initialStateMarked back to summary

initialStateMarked	back to summary
public boolean initialStateMarked() Implements jakarta.faces.component.PartialStateHolder.initialStateMarked. Doc from jakarta.faces.component.PartialStateHolder.initialStateMarked. Return `true` if delta state changes are being tracked, otherwise `false` Returns:boolean `true` if the initial state is marked, `false` otherwise. Annotations @Override

public boolean initialStateMarked()

Implements jakarta.faces.component.PartialStateHolder.initialStateMarked.

Doc from jakarta.faces.component.PartialStateHolder.initialStateMarked.

Return true if delta state changes are being tracked, otherwise false

Returns:boolean

true if the initial state is marked, false otherwise.

Annotations

@Override

isTransient back to summary

isTransient	back to summary
public boolean isTransient() Implements jakarta.faces.component.StateHolder.isTransient. Doc from jakarta.faces.component.StateHolder.isTransient. If true, the Object implementing this interface must not participate in state saving or restoring. Returns:boolean `true` if transient, `false` otherwise. Annotations @Override

public boolean isTransient()

Implements jakarta.faces.component.StateHolder.isTransient.

Doc from jakarta.faces.component.StateHolder.isTransient.

If true, the Object implementing this interface must not participate in state saving or restoring.

Returns:boolean

true if transient, false otherwise.

Annotations

@Override

markInitialState back to summary

markInitialState	back to summary
public void markInitialState() Implements jakarta.faces.component.PartialStateHolder.markInitialState. Doc from jakarta.faces.component.PartialStateHolder.markInitialState. The runtime must ensure that the `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 `initialStateMarked` returns `true` from the time `markInitialState()` is called until `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`. Annotations @Override

public void markInitialState()

Implements jakarta.faces.component.PartialStateHolder.markInitialState.

Doc from jakarta.faces.component.PartialStateHolder.markInitialState.

The runtime must ensure that the 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 initialStateMarked returns true from the time markInitialState() is called until 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.

Annotations

@Override

restoreState back to summary

restoreState	back to summary
public void restoreState(FacesContext context, Object state) Implements jakarta.faces.component.StateHolder.restoreState. Doc from jakarta.faces.component.StateHolder.restoreState. 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 `restoreState` method on all those instances as well. If the `state` argument is `null`, take no action and return. Parameters context:FacesContext the Faces context. state:Object the state. Annotations @Override

public void restoreState(FacesContext context, Object state)

Implements jakarta.faces.component.StateHolder.restoreState.

Doc from jakarta.faces.component.StateHolder.restoreState.

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 restoreState method on all those instances as well.

If the state argument is null, take no action and return.

Parameters

context:FacesContext: the Faces context.
state:Object: the state.

Annotations

@Override

saveState back to summary

saveState	back to summary
public Object saveState(FacesContext context) Implements jakarta.faces.component.StateHolder.saveState. Doc from jakarta.faces.component.StateHolder.saveState. 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 `saveState` method on all those instances as well. This method must not save the state of children and facets. That is done via the `jakarta.faces.application.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` Parameters context:FacesContext the Faces context. Returns:Object the saved state. Annotations @Override

public Object saveState(FacesContext context)

Implements jakarta.faces.component.StateHolder.saveState.

Doc from jakarta.faces.component.StateHolder.saveState.

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 saveState method on all those instances as well. This method must not save the state of children and facets. That is done via the jakarta.faces.application.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

Parameters

context:FacesContext: the Faces context.

Returns:Object

the saved state.

Annotations

@Override

setPattern	back to summary
public void setPattern(String pattern) The Regular Expression property to validate against. Parameters pattern:String a regular expression pattern

setPattern

back to summary

public void setPattern(String pattern)

The Regular Expression property to validate against.

Parameters

pattern:String: a regular expression pattern

setTransient back to summary

setTransient	back to summary
public void setTransient(boolean transientValue) Implements jakarta.faces.component.StateHolder.setTransient. Doc from jakarta.faces.component.StateHolder.setTransient. Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring. Parameters transientValue:boolean boolean pass `true` if this Object will not participate in state saving or restoring, otherwise pass `false`. Annotations @Override

public void setTransient(boolean transientValue)

Implements jakarta.faces.component.StateHolder.setTransient.

Doc from jakarta.faces.component.StateHolder.setTransient.

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Parameters

transientValue:boolean: boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

Annotations

@Override

validate back to summary

validate	back to summary
public void validate(FacesContext context, UIComponent component, Object value) Implements jakarta.faces.validator.Validator.validate. Validate a String against a regular expression pattern. The full regex pattern must be matched in order to pass the validation. Parameters context:FacesContext Doc from jakarta.faces.validator.Validator.validate. FacesContext for the request we are processing component:UIComponent Doc from jakarta.faces.validator.Validator.validate. UIComponent we are checking for correctness value:Object Doc from jakarta.faces.validator.Validator.validate. the value to validate Annotations @Override Exceptions NullPointerException: if `context` or `component` is `null` ValidatorException: if validation fails