org.josef.web.jsf.validator

Class EmailValidator

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.validator.AbstractValidator

org.josef.web.jsf.validator.EmailValidator

All Implemented Interfaces:

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

public class EmailValidator
extends AbstractValidator

A validator that validates an email address.
emailValidationPattern: A EmailValidationPattern, defaults to EmailValidationPattern.BASIC.
message: Error message in case a validation error occurs. This message supports a single argument:{0}=The email address to validate.
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
EmailValidator()

Method Summary

Modifier and Type	Method and Description
EmailValidationPattern	getEmailValidationPattern() Gets the email validation pattern.
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	setEmailValidationPattern(EmailValidationPattern emailValidationPattern) Sets the email validation pattern.
void	validate(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object email) Validates that the supplied value represents a valid email address.

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

EmailValidator

public EmailValidator()

Method Detail

getEmailValidationPattern

public EmailValidationPattern getEmailValidationPattern()

Gets the email validation pattern.

Returns:

The email validation pattern.

setEmailValidationPattern

public void setEmailValidationPattern(EmailValidationPattern emailValidationPattern)

Sets the email validation pattern.

Parameters:

emailValidationPattern - The pattern to match the email address against.

validate

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

Validates that the supplied value represents a valid email address.
In the following cases, no validation will take place:

• The supplied component is not of type UIInput
• The supplied email is null or empty
• The supplied email is not a String

Note: A missing email (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.

email - The email address that needs to be validated.

Throws:

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

javax.faces.validator.ValidatorException - When the supplied email does not represent a valid email address.

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).