EmailValidator (Commons Validator (Version 1.5.0-SNAPSHOT))

java.lang.Object
- org.apache.commons.validator.routines.EmailValidator

All Implemented Interfaces:

java.io.Serializable
```
public class EmailValidator
extends java.lang.Object
implements java.io.Serializable
```
Perform email validations.

Based on a script by Sandeep V. Tamhankar http://javascript.internet.com

This implementation is not guaranteed to catch all possible errors in an email address.
.

Since:

Validator 1.4

Version:

$Revision: 1715080 $

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`allowLocal`
`private boolean`	`allowTld`
`private static java.util.regex.Pattern`	`EMAIL_PATTERN`
`private static java.lang.String`	`EMAIL_REGEX`
`private static EmailValidator`	`EMAIL_VALIDATOR`	Singleton instance of this class, which doesn't consider local addresses as valid.
`private static EmailValidator`	`EMAIL_VALIDATOR_WITH_LOCAL`	Singleton instance of this class, which does consider local addresses valid.
`private static EmailValidator`	`EMAIL_VALIDATOR_WITH_LOCAL_WITH_TLD`	Singleton instance of this class, which does consider local addresses valid.
`private static EmailValidator`	`EMAIL_VALIDATOR_WITH_TLD`	Singleton instance of this class, which doesn't consider local addresses as valid.
`private static java.util.regex.Pattern`	`IP_DOMAIN_PATTERN`
`private static java.lang.String`	`IP_DOMAIN_REGEX`
`private static java.lang.String`	`QUOTED_USER`
`private static long`	`serialVersionUID`
`private static java.lang.String`	`SPECIAL_CHARS`
`private static java.util.regex.Pattern`	`USER_PATTERN`
`private static java.lang.String`	`USER_REGEX`
`private static java.lang.String`	`VALID_CHARS`
`private static java.lang.String`	`WORD`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`EmailValidator(boolean allowLocal)`	Protected constructor for subclasses to use.
`protected`	`EmailValidator(boolean allowLocal, boolean allowTld)`	Protected constructor for subclasses to use.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EmailValidator`	`getInstance()`	Returns the Singleton instance of this validator.
`static EmailValidator`	`getInstance(boolean allowLocal)`	Returns the Singleton instance of this validator, with local validation as required.
`static EmailValidator`	`getInstance(boolean allowLocal, boolean allowTld)`	Returns the Singleton instance of this validator, with local validation as required.
`boolean`	`isValid(java.lang.String email)`	Checks if a field has a valid e-mail address.
`protected boolean`	`isValidDomain(java.lang.String domain)`	Returns true if the domain component of an email address is valid.
`protected boolean`	`isValidUser(java.lang.String user)`	Returns true if the user component of an email address is valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - SPECIAL_CHARS
```
private static final java.lang.String SPECIAL_CHARS
```
    See Also:
    
    Constant Field Values
  - VALID_CHARS
```
private static final java.lang.String VALID_CHARS
```
    See Also:
    
    Constant Field Values
  - QUOTED_USER
```
private static final java.lang.String QUOTED_USER
```
    See Also:
    
    Constant Field Values
  - WORD
```
private static final java.lang.String WORD
```
    See Also:
    
    Constant Field Values
  - EMAIL_REGEX
```
private static final java.lang.String EMAIL_REGEX
```
    See Also:
    
    Constant Field Values
  - IP_DOMAIN_REGEX
```
private static final java.lang.String IP_DOMAIN_REGEX
```
    See Also:
    
    Constant Field Values
  - USER_REGEX
```
private static final java.lang.String USER_REGEX
```
    See Also:
    
    Constant Field Values
  - EMAIL_PATTERN
```
private static final java.util.regex.Pattern EMAIL_PATTERN
```
  - IP_DOMAIN_PATTERN
```
private static final java.util.regex.Pattern IP_DOMAIN_PATTERN
```
  - USER_PATTERN
```
private static final java.util.regex.Pattern USER_PATTERN
```
  - allowLocal
```
private final boolean allowLocal
```
  - allowTld
```
private final boolean allowTld
```
  - EMAIL_VALIDATOR
```
private static final EmailValidator EMAIL_VALIDATOR
```
    Singleton instance of this class, which doesn't consider local addresses as valid.
  - EMAIL_VALIDATOR_WITH_TLD
```
private static final EmailValidator EMAIL_VALIDATOR_WITH_TLD
```
    Singleton instance of this class, which doesn't consider local addresses as valid.
  - EMAIL_VALIDATOR_WITH_LOCAL
```
private static final EmailValidator EMAIL_VALIDATOR_WITH_LOCAL
```
    Singleton instance of this class, which does consider local addresses valid.
  - EMAIL_VALIDATOR_WITH_LOCAL_WITH_TLD
```
private static final EmailValidator EMAIL_VALIDATOR_WITH_LOCAL_WITH_TLD
```
    Singleton instance of this class, which does consider local addresses valid.
- Constructor Detail
  - EmailValidator
```
protected EmailValidator(boolean allowLocal,
                         boolean allowTld)
```
    Protected constructor for subclasses to use.
    
    Parameters:
    
    allowLocal - Should local addresses be considered valid?
  - EmailValidator
```
protected EmailValidator(boolean allowLocal)
```
    Protected constructor for subclasses to use.
    
    Parameters:
    
    allowLocal - Should local addresses be considered valid?
- Method Detail
  - getInstance
```
public static EmailValidator getInstance()
```
    Returns the Singleton instance of this validator.
    
    Returns:
    
    singleton instance of this validator.
  - getInstance
```
public static EmailValidator getInstance(boolean allowLocal,
                                         boolean allowTld)
```
    Returns the Singleton instance of this validator, with local validation as required.
    
    Parameters:
    
    allowLocal - Should local addresses be considered valid?
    
    Returns:
    
    singleton instance of this validator
  - getInstance
```
public static EmailValidator getInstance(boolean allowLocal)
```
    Returns the Singleton instance of this validator, with local validation as required.
    
    Parameters:
    
    allowLocal - Should local addresses be considered valid?
    
    Returns:
    
    singleton instance of this validator
  - isValid
```
public boolean isValid(java.lang.String email)
```
    Checks if a field has a valid e-mail address.
    
    Parameters:
    
    email - The value validation is being performed on. A null value is considered invalid.
    
    Returns:
    
    true if the email address is valid.
  - isValidDomain
```
protected boolean isValidDomain(java.lang.String domain)
```
    Returns true if the domain component of an email address is valid.
    
    Parameters:
    
    domain - being validated, may be in IDN format
    
    Returns:
    
    true if the email address's domain is valid.
  - isValidUser
```
protected boolean isValidUser(java.lang.String user)
```
    Returns true if the user component of an email address is valid.
    
    Parameters:
    
    user - being validated
    
    Returns:
    
    true if the user name is valid.

Class EmailValidator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

SPECIAL_CHARS

VALID_CHARS

QUOTED_USER

WORD

EMAIL_REGEX

IP_DOMAIN_REGEX

USER_REGEX

EMAIL_PATTERN

IP_DOMAIN_PATTERN

USER_PATTERN

allowLocal

allowTld

EMAIL_VALIDATOR

EMAIL_VALIDATOR_WITH_TLD

EMAIL_VALIDATOR_WITH_LOCAL

EMAIL_VALIDATOR_WITH_LOCAL_WITH_TLD

Constructor Detail

EmailValidator

EmailValidator

Method Detail

getInstance

getInstance

getInstance

isValid

isValidDomain

isValidUser