org.columba.ristretto.message

Class Address

java.lang.Object

org.columba.ristretto.message.Address

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Address>

public class Address
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<Address>

Address is the representation of a mail address as specified by RFC 2822. It consistis of a human readable display name and the technical mail address.

Author:

Timo Stich

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Address(java.lang.String mailAddress) Construct a Address with a valid mail address that must not be parsed.
Address(java.lang.String displayName, java.lang.String mailAddress) Contruct a Address with a valid mail address and a displayname.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Address arg0)
boolean	equals(java.lang.Object arg0)
java.lang.String	getCanonicalMailAddress() Get the canonical form of the mailaddress.
java.lang.String	getDisplayName() Gets the displayname.
java.lang.String	getMailAddress() Gets the mail address.
java.lang.String	getShortAddress() Gets the short form of the address.
int	hashCode()
static Address	parse(java.lang.CharSequence source) Uses the AddressParser to parse the CharSequence.
void	setDisplayName(java.lang.String displayName) Sets the displayname.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Address

public Address(java.lang.String mailAddress)

Construct a Address with a valid mail address that must not be parsed.

Note: If you want to parse an Address from a String use the static parse(CharSequence) instead.

Parameters:

mailAddress - a valid mail address (e.g. my@mail.org).

Address

public Address(java.lang.String displayName,
               java.lang.String mailAddress)

Contruct a Address with a valid mail address and a displayname.

Note: If you want to parse an Address from a String use the static parse(CharSequence) instead.

Parameters:

displayName - the name to display for this address, i.e. the real name (e.g. Timo Stich).

mailAddress - A valid mail address (e.g. my@mail.org).

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Gets the displayname. The returned String can be used to give a human readable representation of the mail address.

Example: "Timo Stich"

Returns:

the human readable String representation or null if not set.

getMailAddress

public java.lang.String getMailAddress()

Gets the mail address. This is the technical part of the mail address as defined in RFC 2822.

Example: my@mail.org

Returns:

the mail address

getCanonicalMailAddress

public java.lang.String getCanonicalMailAddress()

Get the canonical form of the mailaddress. This is basically the technical mail address in brackets and is defined in RFC 2822.

Example: <my@mail.org>

Returns:

the canonical form of the mailaddress

getShortAddress

public java.lang.String getShortAddress()

Gets the short form of the address. This is either the human readable display name if available or the technical mail address.

Examples: "Timo Stich" or "my@mail.org"

Returns:

the short form of the address

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the displayname. This is the human readable part of the address.

Example: "Timo Stich"

Parameters:

displayName - the human readable representation of the address.

equals

public boolean equals(java.lang.Object arg0)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

compareTo

public int compareTo(Address arg0)

Specified by:

compareTo in interface java.lang.Comparable<Address>

See Also:

Comparable.compareTo(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

parse

public static Address parse(java.lang.CharSequence source)
                     throws ParserException

Uses the AddressParser to parse the CharSequence.

Parameters:

source - the address that is parsed, e.g. "Timo Stich <my@mail.org>"

Returns:

the Address object that represents the input CharSequence

Throws:

ParserException