com.upokecenter.mail.NamedAddress

com.upokecenter.mail.NamedAddress

public class NamedAddress extends Object

Represents an email address and a name for that address. Can represent a group of email addresses instead.

Constructors

Methods

• boolean AddressesEqual(NamedAddress na)
  Determines whether the email addresses stored this object are the same between this object and the given object, regardless of the display names they store.

• boolean equals(Object obj)
  Determines whether this object and another object are equal.

• final Address getAddress()
  Gets the email address associated with this object.

• final String getDisplayName()
  Gets the display name for this email address.

• final List<NamedAddress> getGroupAddresses()
  Gets a read-only list of addresses that make up the group, if this object represents a group, or an empty list otherwise.

• final String getName()
  Gets the display name for this email address, or the email address's value if the display name is null.

• int hashCode()
  Calculates the hash code of this object.

• final boolean isGroup()
  Gets a value indicating whether this represents a group of addresses rather than a single address.

• static List<NamedAddress> ParseAddresses(String addressValue)
  Generates a list of NamedAddress objects from a comma-separated list of addresses.

• String ToDisplayString()
  Converts this named-address object to a text string intended for display to end users.

• static String ToDisplayString(List<NamedAddress> addresses)
  Generates a string containing the display names and email addresses of the given named-address objects, separated by commas.

• static String ToDisplayStringShort(List<NamedAddress> addresses)
  Generates a string containing the display names of the given named-address objects, separated by commas.

• String toString()
  Converts this object to a text string.

Method Details

ToDisplayStringShort

public static String ToDisplayStringShort(List<NamedAddress> addresses)

Generates a string containing the display names of the given named-address objects, separated by commas. The generated string is intended to be displayed to end users, and is not intended to be parsed by computer programs. If a named address has no display name, its email address is used as the display name.

Parameters:

• addresses - A list of named address objects.

Returns:

• A string containing the display names of the given named-address objects, separated by commas.

Throws:

• NullPointerException - The parameter addresses is null.

ToDisplayString

public static String ToDisplayString(List<NamedAddress> addresses)

Generates a string containing the display names and email addresses of the given named-address objects, separated by commas. The generated string is intended to be displayed to end users, and is not intended to be parsed by computer programs.

Parameters:

• addresses - A list of named address objects.

Returns:

• A string containing the display names and email addresses of the given named-address objects, separated by commas.

Throws:

• NullPointerException - The parameter addresses is null.

ParseAddresses

public static List<NamedAddress> ParseAddresses(String addressValue)

Generates a list of NamedAddress objects from a comma-separated list of addresses. Each address must follow the syntax accepted by the one-argument constructor of NamedAddress.

Parameters:

• addressValue - A comma-separated list of addresses in the form of a text string.

Returns:

• A list of addresses generated from the addressValue parameter.

Throws:

• NullPointerException - The parameter addressValue is null.

hashCode

public int hashCode()

Calculates the hash code of this object. The exact algorithm used by this method is not guaranteed to be the same between versions of this library, and no application or process IDs are used in the hash code calculation.

Overrides:

• hashCode in class Object

Returns:

• A 32-bit hash code.

equals

public boolean equals(Object obj)

Determines whether this object and another object are equal. For groups, the named addresses (display name/email address pairs) must be equal and in the same order in both objects.

Overrides:

• equals in class Object

Parameters:

• obj - An arbitrary object to compare with this one.

Returns:

• true if this object and another object are equal and have the same type; otherwise, false.

AddressesEqual

public boolean AddressesEqual(NamedAddress na)

Determines whether the email addresses stored this object are the same between this object and the given object, regardless of the display names they store. For groups, the email addresses must be equal and in the same order in both objects.

Parameters:

• na - A named address object to compare with this one. Can be null.

Returns:

• Either true or false.

getName

public final String getName()

Gets the display name for this email address, or the email address's value if the display name is null. Returns an empty string if the address and display name are null.

Returns:

• The name for this email address.

getDisplayName

public final String getDisplayName()

Gets the display name for this email address.

Returns:

• The display name for this email address. Returns null if the display name is absent.

getAddress

public final Address getAddress()

Gets the email address associated with this object.

Returns:

• The email address associated with this object. This value is null if this object represents a group of addresses instead.

isGroup

public final boolean isGroup()

Gets a value indicating whether this represents a group of addresses rather than a single address.

Returns:

• true If this represents a group of addresses; otherwise, false.

toString

public String toString()

Converts this object to a text string. This will generally be the form of this NamedAddress object as it could appear in a "To" header field.

Overrides:

• toString in class Object

Returns:

• A string representation of this object.

ToDisplayString

public String ToDisplayString()

Converts this named-address object to a text string intended for display to end users. The returned string is not intended to be parsed by computer programs.

Returns:

• A text string of this named-address object, intended for display to end-users.

getGroupAddresses

public final List<NamedAddress> getGroupAddresses()

Gets a read-only list of addresses that make up the group, if this object represents a group, or an empty list otherwise.

Returns:

• A list of addresses that make up the group, if this object represents a group, or an empty list otherwise.

Back to MailLib start page.