Package com.globalmentor.net

Class EmailAddress

java.lang.Object

com.globalmentor.net.EmailAddress

All Implemented Interfaces:

Resource, Comparable<EmailAddress>

public final class EmailAddress
extends Object
implements Resource, Comparable<EmailAddress>

Value class for email addresses represented in the form specified by RFC 5322: Internet Message Format.

Author:

Garret Wilson

See Also:

• RFC 5322

Field Summary

Fields

Modifier and Type	Field	Description
static final Characters	ATEXT_CHARACTERS	Email address atext characters as per RFC 5322.
static final char	DOMAIN_LITERAL_BEGIN	The beginning delimiter of a domain-literal.
static final char	DOMAIN_LITERAL_END	The ending delimiter of a domain-literal.
static final Pattern	DOMAIN_PATTERN	A regular expression pattern for matching the domain of an email addresses according to RFC 5322.
static final Characters	DTEXT_CHARACTERS	Email address dtext characters as per RFC 5322.
static final Pattern	EMAIL_ADDRESS_PATTERN	A regular expression pattern for matching email addresses according to RFC 5322.
static final int	EMAIL_ADDRESS_PATTERN_DOMAIN_GROUP	The group for returning the domain of an email address from a matcher derived from EMAIL_ADDRESS_PATTERN.
static final int	EMAIL_ADDRESS_PATTERN_LOCAL_PART_GROUP	The group for returning the local part of an email address from a matcher derived from EMAIL_ADDRESS_PATTERN.
static final char	LOCAL_PART_DOMAIN_DELIMITER	The delimiter separating the local part from the domain.
static final Pattern	LOCAL_PART_PATTERN	A regular expression pattern for matching the local part of an email addresses according to RFC 5322.

Fields inherited from interface com.globalmentor.net.Resource

URI_PROPERTY_NAME

Method Summary

Modifier and Type	Method	Description
int	compareTo(EmailAddress emailAddress)	Compares this object with the specified object for order.
boolean	equals(Object object)	Determines if this object is equivalent to another object.
static EmailAddress	fromString(String input)	Constructs an email address from a string.
String	getDomain()
static String	getDomain(CharSequence input)	Returns the domain of an email address from a string.
String	getLocalPart()
static String	getLocalPart(CharSequence input)	Returns the local part of an email address from a string.
URI	getURI()
int	hashCode()
static EmailAddress	of(String localPart, String domain)	Constructs an email address from its separate components.
String	toString()	Constructs a string representation of the email address in its RFC 5322 format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ATEXT_CHARACTERS

public static final Characters ATEXT_CHARACTERS

Email address atext characters as per RFC 5322.

Printable US-ASCII characters not including specials. Used for atoms.

DTEXT_CHARACTERS

public static final Characters DTEXT_CHARACTERS

Email address dtext characters as per RFC 5322. This definition does not include the obsolete obs-dtext from RFC 5322.

Printable US-ASCII characters not including "[", "]", or "\".

LOCAL_PART_DOMAIN_DELIMITER

public static final char LOCAL_PART_DOMAIN_DELIMITER

The delimiter separating the local part from the domain.

See Also:

• Constant Field Values

DOMAIN_LITERAL_BEGIN

public static final char DOMAIN_LITERAL_BEGIN

The beginning delimiter of a domain-literal.

See Also:

• Constant Field Values

DOMAIN_LITERAL_END

public static final char DOMAIN_LITERAL_END

The ending delimiter of a domain-literal.

See Also:

• Constant Field Values

LOCAL_PART_PATTERN

public static final Pattern LOCAL_PART_PATTERN

A regular expression pattern for matching the local part of an email addresses according to RFC 5322. This pattern is derived from the regular expression provided at an answer to Using a regular expression to validate an email address.

See Also:

• Using a regular expression to validate an email address

DOMAIN_PATTERN

public static final Pattern DOMAIN_PATTERN

A regular expression pattern for matching the domain of an email addresses according to RFC 5322. This pattern is derived from the regular expression provided at an answer to Using a regular expression to validate an email address.

See Also:

• Using a regular expression to validate an email address

EMAIL_ADDRESS_PATTERN

public static final Pattern EMAIL_ADDRESS_PATTERN

A regular expression pattern for matching email addresses according to RFC 5322. This pattern is derived from the regular expression provided at an answer to Using a regular expression to validate an email address.

See Also:

• Using a regular expression to validate an email address
• EMAIL_ADDRESS_PATTERN_LOCAL_PART_GROUP
• EMAIL_ADDRESS_PATTERN_DOMAIN_GROUP
• LOCAL_PART_PATTERN
• LOCAL_PART_DOMAIN_DELIMITER
• DOMAIN_PATTERN

EMAIL_ADDRESS_PATTERN_LOCAL_PART_GROUP

public static final int EMAIL_ADDRESS_PATTERN_LOCAL_PART_GROUP

The group for returning the local part of an email address from a matcher derived from EMAIL_ADDRESS_PATTERN.

See Also:

• Constant Field Values

EMAIL_ADDRESS_PATTERN_DOMAIN_GROUP

public static final int EMAIL_ADDRESS_PATTERN_DOMAIN_GROUP

The group for returning the domain of an email address from a matcher derived from EMAIL_ADDRESS_PATTERN.

See Also:

• Constant Field Values

Method Details

getLocalPart

public String getLocalPart()

Returns:

The local part of the email address.

getDomain

public String getDomain()

Returns:

The domain of the email address.

of

public static EmailAddress of(String localPart,
 String domain)
                       throws ArgumentSyntaxException

Constructs an email address from its separate components.

Parameters:

localPart - The local part of the email address.

domain - The domain of the email address.

Returns:

An email address with the given local part and domain.

Throws:

NullPointerException - if the given local part and/or domain is null.

ArgumentSyntaxException - if the given local part and/or domain violates RFC 5322.

fromString

public static EmailAddress fromString(String input)
                               throws ArgumentSyntaxException

Constructs an email address from a string.

Parameters:

input - The string to be parsed as an email address.

Returns:

An email address from the given string representation.

Throws:

NullPointerException - if the given character sequence is null.

ArgumentSyntaxException - if the input string violates RFC 5322.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

A hash code representing this object.

equals

public boolean equals(Object object)

Determines if this object is equivalent to another object. This method considers another object equivalent if it is another email address with the same local part and domain.

Overrides:

equals in class Object

Returns:

true if the given object is an equivalent email address.

compareTo

public int compareTo(EmailAddress emailAddress)

Compares this object with the specified object for order. This implementation primarily by domain and secondarily by local part, ignoring case and locales.

Specified by:

compareTo in interface Comparable<EmailAddress>

Parameters:

emailAddress - The object to be compared.

Returns:

A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

See Also:

• getDomain()
• getLocalPart()

toString

public String toString()

Constructs a string representation of the email address in its RFC 5322 format. This implementation returns the canonical version of the email address.

Overrides:

toString in class Object

Returns:

A string representation of the email address.

getURI

public URI getURI()

Specified by:

getURI in interface Resource

Returns:

The resource identifier URI, or null if the identifier is not known.

getLocalPart

public static String getLocalPart(CharSequence input)
                           throws ArgumentSyntaxException

Returns the local part of an email address from a string.

Parameters:

input - The character sequence to be parsed as an email address.

Returns:

The local part of the given email address.

Throws:

NullPointerException - if the given character sequence is null.

ArgumentSyntaxException - if the input string violates RFC 5322.

getDomain

public static String getDomain(CharSequence input)
                        throws ArgumentSyntaxException

Returns the domain of an email address from a string.

Parameters:

input - The character sequence to be parsed as an email address.

Returns:

The domain of the given email address.

Throws:

NullPointerException - if the given character sequence is null.

ArgumentSyntaxException - if the input string violates RFC 5322.