Module com.aoapps.net.types

Package com.aoapps.net

Class Email

java.lang.Object

com.aoapps.net.Email

All Implemented Interfaces:

DtoFactory<Email>, FastExternalizable, Internable<Email>, Externalizable, Serializable, Comparable<Email>, SQLData

public final class Email
extends Object
implements Comparable<Email>, FastExternalizable, DtoFactory<Email>, Internable<Email>, SQLData

Represents an email address. Email addresses must:

• Be non-null
• Be non-empty
• Contain a single @, but not at the beginning or end
• Local part must adhere to RFC 5322.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_LENGTH
static final int	MAX_LOCAL_PART_LENGTH
static final String	SQL_TYPE

Constructor Summary

Constructors

Constructor	Description
Email()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Email other)	Sorts by domain and then by local part.
boolean	equals(Object obj)
DomainName	getDomain()
Email	getDto()
String	getLocalPart()
long	getSerialVersionUID()
String	getSQLTypeName()
int	hashCode()
Email	intern()	Interns this email much in the same fashion as String.intern().
void	readExternal(ObjectInput in)
void	readSQL(SQLInput stream, String typeName)
String	toString()
static ValidationResult	validate(String email)	Validates a complete email address.
static ValidationResult	validate(String localPart, DomainName domain)	Validates the local part of the email address (before the @ symbol), as well as additional domain rules.
static ValidationResult	validate(String localPart, String domain)	Validates the local part of the email address (before the @ symbol), as well as additional domain rules.
static Email	valueOf(String email)
static Email	valueOf(String localPart, DomainName domain)
void	writeExternal(ObjectOutput out)
void	writeSQL(SQLOutput stream)

Methods inherited from class java.lang.Object

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

Field Details

MAX_LENGTH

public static final int MAX_LENGTH

See Also:

• Constant Field Values

MAX_LOCAL_PART_LENGTH

public static final int MAX_LOCAL_PART_LENGTH

See Also:

• Constant Field Values

SQL_TYPE

public static final String SQL_TYPE

See Also:

• Constant Field Values

Constructor Details

Email

@Deprecated(forRemoval=false)
public Email()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• FastExternalizable

Method Details

validate

public static ValidationResult validate(String email)

Validates a complete email address. Splits on @ and calls validate on local part and domain.

See Also:

• validate(java.lang.String, com.aoapps.net.DomainName)

validate

public static ValidationResult validate(String localPart,
 String domain)

Validates the local part of the email address (before the @ symbol), as well as additional domain rules.

validate

public static ValidationResult validate(String localPart,
 DomainName domain)

Validates the local part of the email address (before the @ symbol), as well as additional domain rules.

valueOf

public static Email valueOf(String email)
                     throws ValidationException

Parameters:

email - when null, returns null

Throws:

ValidationException

See Also:

• valueOf(java.lang.String, com.aoapps.net.DomainName)

valueOf

public static Email valueOf(String localPart,
 DomainName domain)
                     throws ValidationException

Throws:

ValidationException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Email other)

Sorts by domain and then by local part.

Specified by:

compareTo in interface Comparable<Email>

toString

public String toString()

Overrides:

toString in class Object

intern

public Email intern()

Interns this email much in the same fashion as String.intern().

Specified by:

intern in interface Internable<Email>

See Also:

• String.intern()

getLocalPart

public String getLocalPart()

getDomain

public DomainName getDomain()

getDto

public Email getDto()

Specified by:

getDto in interface DtoFactory<Email>

getSerialVersionUID

public long getSerialVersionUID()

Specified by:

getSerialVersionUID in interface FastExternalizable

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

getSQLTypeName

public String getSQLTypeName()

Specified by:

getSQLTypeName in interface SQLData

writeSQL

public void writeSQL(SQLOutput stream)
              throws SQLException

Specified by:

writeSQL in interface SQLData

Throws:

SQLException

readSQL

public void readSQL(SQLInput stream,
 String typeName)
             throws SQLException

Specified by:

readSQL in interface SQLData

Throws:

SQLException