org.josef.web.jsf.validator

Class PatternValidator

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.validator.AbstractValidator

org.josef.web.jsf.validator.PatternValidator

All Implemented Interfaces:

EventListener, javax.faces.component.StateHolder, javax.faces.validator.Validator

public class PatternValidator
extends AbstractValidator

A validator that validates a value against a pattern (regular expression).
Usage: <jf:patternValidator pattern="..." [message="..."] />
message: Error message in case a validation error occurs. This message supports two arguments:
{0}=The value
{1}=The pattern
In the absence of the message attribute, this validator will use a build in, standard error message.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Field Summary

Fields inherited from interface javax.faces.validator.Validator

NOT_IN_RANGE_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
PatternValidator()

Method Summary

Modifier and Type	Method and Description
String	getPattern() Gets the pattern (regular expression) to validate against.
void	restoreState(javax.faces.context.FacesContext facesContext, Object state) Restores the state saved by saveState(FacesContext).
Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of this validator.
void	setPattern(String pattern) Sets the pattern (regular expression) to validate against.
void	validate(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object value) Validates the supplied value against the pattern.

Methods inherited from class org.josef.web.jsf.validator.AbstractValidator

getFormattedErrorMessage, getMessage, hasMessage, isComponentOfTypeUIInput, setMessage

Methods inherited from class org.josef.web.jsf.AbstractStateHolder

isTransient, setTransient

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternValidator

public PatternValidator()

Method Detail

getPattern

public String getPattern()

Gets the pattern (regular expression) to validate against.

Returns:

The pattern (regular expression) to validate against.
The pattern can possibly be null or empty.

See Also:

Pattern

setPattern

public void setPattern(String pattern)

Sets the pattern (regular expression) to validate against.

Parameters:

pattern - The pattern (regular expression) to validate against.
This must be a legal java regular expression. A null pattern is allowed but is not advisable since it always matches! The same is true for an invalid pattern!

See Also:

Pattern

validate

public void validate(javax.faces.context.FacesContext facesContext,
                     javax.faces.component.UIComponent component,
                     Object value)

Validates the supplied value against the pattern.
In the following cases, no validation will take place:

• The supplied component is not of type UIInput (*)
• The supplied value is null or empty
• The contained pattern is null or empty
• The contained pattern is not valid (*)

Conditions marked with (*) are logged as a severe message.
Note: A missing value (null or empty) is not handled by this validator since it should be handled by the required attribute of the component.

Parameters:

facesContext - The FacesContext.

component - The component that needs to be validated.

value - The value of the component that needs to be validated.

Throws:

NullPointerException - When either the supplied facesContext or component is null.

javax.faces.validator.ValidatorException - When the supplied value does not match the pattern.

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)

Saves the state of this validator.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractValidator

Parameters:

facesContext - The FacesContext.

Returns:

The saved state of this validator.

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)

Restores the state saved by saveState(FacesContext).

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class AbstractValidator

Parameters:

facesContext - The FacesContext.

state - The state saved by saveState(FacesContext).