org.josef.util

Enum EmailValidationPattern

java.lang.Object

java.lang.Enum<EmailValidationPattern>

org.josef.util.EmailValidationPattern

All Implemented Interfaces:

Serializable, Comparable<EmailValidationPattern>

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2011-02-17")
public enum EmailValidationPattern
extends Enum<EmailValidationPattern>

Enumeration of patterns to use for email address verification.
Information about the used patterns can be found here. Note: Since 2015 a lot of TLD (top level domains) are possible. It is not feasible anymore to list them in a regular expression. So be careful with email addresses that are accepted by this class since it could very well be an illegal address. Even though the email address is valid, doesn't mean that the email address actually exists!

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASIC Basic pattern.
RFC2822 RFC2822 pattern.

Method Summary

Modifier and Type	Method and Description
Pattern	getPattern() Gets the pattern to verify an email address against.
boolean	isValidEmail(String email) Determines whether the supplied email is valid with respect to this EmailValidationPattern.
static EmailValidationPattern	valueOf(String name) Returns the enum constant of this type with the specified name.
static EmailValidationPattern[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BASIC

public static final EmailValidationPattern BASIC

Basic pattern.
Used for basic validation. This pattern does not support special characters (except for '-' and '_' and it will allow any alpha top level domain name consisting of 2 to 15 characters.

RFC2822

public static final EmailValidationPattern RFC2822

RFC2822 pattern.
Used for more or less, strict RFC 2822 validation. Most notably, this expression supports neither double quotes nor square brackets.
Note: As of 2015 lots of TLD's (top level domains) are allowed so the TLD restriction has been relaxed.

Method Detail

values

public static EmailValidationPattern[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EmailValidationPattern c : EmailValidationPattern.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EmailValidationPattern valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getPattern

public Pattern getPattern()

Gets the pattern to verify an email address against.

Returns:

The pattern to verify an email address against.

isValidEmail

public boolean isValidEmail(String email)

Determines whether the supplied email is valid with respect to this EmailValidationPattern.

Parameters:

email - The email address to validate.

Returns:

True when the email address is valid, otherwise false is returned.