Package javax.faces.validator

Class RegexValidator

  • All Implemented Interfaces:
    java.util.EventListener, PartialStateHolder, StateHolder, Validator

    public class RegexValidator
extends java.lang.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

    • 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.
      java.lang.String getPattern​()
      Return the ValueExpression that yields the regular expression pattern when evaluated.
      boolean initialStateMarked​()
      Return true if delta state changes are being tracked, otherwise false
      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 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.
      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 setPattern​(java.lang.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, java.lang.Object value)
      Validate a String against a regular expression pattern.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • VALIDATOR_ID

        public static final java.lang.String VALIDATOR_ID

        The standard converter id for this converter.

        See Also:
        Constant Field Values

      • PATTERN_NOT_SET_MESSAGE_ID

        public static final java.lang.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.

        See Also:
        Constant Field Values

      • NOT_MATCHED_MESSAGE_ID

        public static final java.lang.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.

        See Also:
        Constant Field Values

      • MATCH_EXCEPTION_MESSAGE_ID

        public static final java.lang.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.

        See Also:
        Constant Field Values

    • Constructor Detail

      • RegexValidator

        public RegexValidator​()

    • Method Detail

      • setPattern

        public void setPattern​(java.lang.String pattern)

        The Regular Expression property to validate against.

        Parameters:
        pattern - a regular expression pattern

      • getPattern

        public java.lang.String getPattern​()

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

        Returns:
        the pattern

      • validate

        public void validate​(FacesContext context,
                     UIComponent component,
                     java.lang.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 interface Validator
        Parameters:
        context - FacesContext for the request we are processing
        component - UIComponent we are checking for correctness
        value - the value to validate
        Throws:
        java.lang.NullPointerException - if context or component is null
        ValidatorException - if validation fails

      • saveState

        public java.lang.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 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

        Specified by:
        saveState in interface StateHolder
        Parameters:
        context - the Faces context.
        Returns:
        the saved state.

      • restoreState

        public void restoreState​(FacesContext context,
                         java.lang.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 the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

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

        Specified by:
        restoreState in interface StateHolder
        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 interface StateHolder
        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 interface StateHolder
        Parameters:
        transientValue - boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

      • initialStateMarked

        public boolean initialStateMarked​()
        Description copied from interface: PartialStateHolder

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

        Specified by:
        initialStateMarked in interface PartialStateHolder
        Returns:
        true if the initial state is marked, false otherwise.