Package com.vaadin.flow.data.validator

Class EmailValidator

java.lang.Object

com.vaadin.flow.data.validator.AbstractValidator<String>

com.vaadin.flow.data.validator.RegexpValidator

com.vaadin.flow.data.validator.EmailValidator

All Implemented Interfaces:

Validator<String>, Serializable, BiFunction<String,ValueContext,ValidationResult>

public class EmailValidator
extends RegexpValidator

A string validator for e-mail addresses. The e-mail address syntax is not complete according to RFC 822 but handles the vast majority of valid e-mail addresses correctly.

Since:

1.0.

Author:

Vaadin Ltd

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATTERN

Constructor Summary

Constructors

Constructor	Description
EmailValidator(String errorMessage)	Creates a validator for checking that a string is a syntactically valid e-mail address.
EmailValidator(String errorMessage, boolean allowEmpty)	Creates a validator for checking that a string is a syntactically valid e-mail address.

Method Summary

Modifier and Type	Method	Description
protected boolean	isValid(String value)	Returns whether the given string matches the regular expression.

Methods inherited from class com.vaadin.flow.data.validator.RegexpValidator

apply, toString

Methods inherited from class com.vaadin.flow.data.validator.AbstractValidator

getMessage, toResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Field Details

PATTERN

public static final String PATTERN

See Also:

• Constant Field Values

Constructor Details

EmailValidator

public EmailValidator(String errorMessage)

Creates a validator for checking that a string is a syntactically valid e-mail address.

This constructor creates a validator which doesn't accept an empty string as a valid e-mail address. Use EmailValidator(String, boolean) constructor with true as a value for the second argument to create a validator which accepts an empty string.

Parameters:

errorMessage - the message to display in case the value does not validate.

See Also:

• EmailValidator(String, boolean)

EmailValidator

public EmailValidator(String errorMessage,
 boolean allowEmpty)

Creates a validator for checking that a string is a syntactically valid e-mail address.

Parameters:

errorMessage - the message to display in case the value does not validate.

allowEmpty - if true then an empty string passes the validation, otherwise the validation fails

Method Details

isValid

protected boolean isValid(String value)

Description copied from class: RegexpValidator

Returns whether the given string matches the regular expression.

Overrides:

isValid in class RegexpValidator

Parameters:

value - the string to match

Returns:

true if the string matched, false otherwise