com.aspose.email

Class EmailAddress

java.lang.Object

com.aspose.email.MailAddress

com.aspose.email.EmailAddress

All Implemented Interfaces:

IMailAddress, IEquatable<EmailAddress>, Comparable<EmailAddress>

public class EmailAddress
extends MailAddress
implements Comparable<EmailAddress>, IEquatable<EmailAddress>

Represents an email address

Constructor Summary

Constructors

Constructor and Description
EmailAddress() Initializes a new instance of the EmailAddress class.
EmailAddress(String address) Initializes a new instance of the EmailAddress class.
EmailAddress(String address, String displayName) Initializes a new instance of the EmailAddress class.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(EmailAddress obj) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
boolean	equals(EmailAddress obj) Determines whether the specified Object is equal to the current Object.
boolean	equals(EmailAddress x, EmailAddress y) Determines whether the specified object instances are considered equal.
boolean	equals(Object obj) Determines whether the specified Object is equal to the current Object.
EmailAddressCategory	getCategory() Gets or sets an object category
boolean	getPrefered() Gets or sets a value which defines whether email address is preferred.
String	getRoutingType() Gets or sets a routing type for an email
int	hashCode() GetHashCode returns a hash function for this object.
int	hashCode(EmailAddress obj) GetHashCode returns a hash function for specified object.
static boolean	op_Equality(EmailAddress a, EmailAddress b) Determines whether the specified objects are equal.
static boolean	op_Inequality(EmailAddress a, EmailAddress b) Determines whether the specified objects are not equal.
void	setCategory(EmailAddressCategory value) Gets or sets an object category
void	setPrefered(boolean value) Gets or sets a value which defines whether email address is preferred.
void	setRoutingType(String value) Gets or sets a routing type for an email
String	toString() Returns a string that represents the current object.

Methods inherited from class com.aspose.email.MailAddress

get_Item, getAddress, getCount, getDisplayName, getHost, getId, getOriginalAddressString, getParticipationStatus, getUser, getX500Address, setAddress, setDisplayName, setParticipationStatus, to_MailAddress, to_MailAddress, toX500String

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailAddress

public EmailAddress()

Initializes a new instance of the EmailAddress class.

EmailAddress

public EmailAddress(String address)

Initializes a new instance of the EmailAddress class.

Parameters:

address - The mail address.

EmailAddress

public EmailAddress(String address,
            String displayName)

Initializes a new instance of the EmailAddress class.

Parameters:

address - The mail address.

displayName - The display name.

Method Detail

getPrefered

public final boolean getPrefered()

Gets or sets a value which defines whether email address is preferred.

setPrefered

public final void setPrefered(boolean value)

Gets or sets a value which defines whether email address is preferred.

getCategory

public final EmailAddressCategory getCategory()

Gets or sets an object category

setCategory

public final void setCategory(EmailAddressCategory value)

Gets or sets an object category

getRoutingType

public final String getRoutingType()

Gets or sets a routing type for an email

setRoutingType

public final void setRoutingType(String value)

Gets or sets a routing type for an email

toString

public String toString()

Returns a string that represents the current object.

Overrides:

toString in class MailAddress

Returns:

Returns a string that represents the current object.

hashCode

public int hashCode()

GetHashCode returns a hash function for this object.

Overrides:

hashCode in class MailAddress

Returns:

Returns a hash function for this object.

hashCode

public final int hashCode(EmailAddress obj)

GetHashCode returns a hash function for specified object.

Parameters:

obj - The Object for which a hash code is to be returned.

Returns:

Returns a hash function for specified object.

equals

public boolean equals(Object obj)

Determines whether the specified Object is equal to the current Object.

Specified by:

equals in interface IEquatable<EmailAddress>

Overrides:

equals in class MailAddress

Parameters:

obj - The Object to compare with the current Object.

Returns:

Returns a boolean indicating if the passed in object obj is Equal to this.

equals

public final boolean equals(EmailAddress obj)

Determines whether the specified Object is equal to the current Object.

Parameters:

obj - The Object to compare with the current Object.

Returns:

Returns a boolean indicating if the passed in object obj is Equal to this.

equals

public final boolean equals(EmailAddress x,
             EmailAddress y)

Determines whether the specified object instances are considered equal.

Parameters:

x - The first object to compare.

y - The second object to compare.

Returns:

true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

op_Equality

public static boolean op_Equality(EmailAddress a,
                  EmailAddress b)

Determines whether the specified objects are equal.

Parameters:

a - First object to compare

b - Second object to compare

Returns:

Returns true if objects are equal, otherwise false.

op_Inequality

public static boolean op_Inequality(EmailAddress a,
                    EmailAddress b)

Determines whether the specified objects are not equal.

Parameters:

a - First object to compare

b - Second object to compare

Returns:

Returns true if objects are not equal, otherwise false.

compareTo

public int compareTo(EmailAddress obj)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Specified by:

compareTo in interface Comparable<EmailAddress>

Parameters:

obj - An object to compare with this instance, or null.

Returns:

This method returns: a value less than 0 if this is less than value 0 if this is equal to value a value greater than 0 if this is greater than value