org.eclipse.ecf.protocol.msn
Class Contact

java.lang.Object
  org.eclipse.ecf.protocol.msn.Contact

public final class Contact
extends java.lang.Object

This class represents a contact that a user has on his or her MSN list.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Method Summary

void	addContactListener(IContactListener listener) Adds a IContactListener to this contact.
boolean	equals(java.lang.Object obj) Returns whether the specified object is equal to this.
java.lang.String	getDisplayName() Gets the displayed name of this contact.
java.lang.String	getEmail() Returns the email address of the user.
java.util.Collection	getGroups() Retrieves the groups that this contact is a part of.
java.lang.String	getPersonalMessage() Returns the personal message that this contact is currently using.
Status	getStatus() Retrieves the current status of this contact.
int	hashCode() Returns a unique integer hash code for this contact.
void	removeContactListener(IContactListener listener) Removes a IContactListener from this contact.
java.lang.String	toString() Returns this contact's email address that's being used for identification purposes in MSN.

Methods inherited from class java.lang.Object

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

Method Detail

getGroups

public java.util.Collection getGroups()

Retrieves the groups that this contact is a part of.

Returns:

a collection of the groups that this contact is a member of

getStatus

public Status getStatus()

Retrieves the current status of this contact.

Returns:

the status that this contact currently is in

getDisplayName

public java.lang.String getDisplayName()

Gets the displayed name of this contact.

Returns:

the name that this contact uses

getPersonalMessage

public java.lang.String getPersonalMessage()

Returns the personal message that this contact is currently using.

Returns:

the personal message in use

getEmail

public java.lang.String getEmail()

Returns the email address of the user.

Returns:

the user's email address

addContactListener

public void addContactListener(IContactListener listener)

Adds a IContactListener to this contact.

Parameters:

listener - the listener to be added

removeContactListener

public void removeContactListener(IContactListener listener)

Removes a IContactListener from this contact.

Parameters:

listener - the listener to be removed

toString

public java.lang.String toString()

Returns this contact's email address that's being used for identification purposes in MSN.

Overrides:

toString in class java.lang.Object

Returns:

the contact's email address

equals

public boolean equals(java.lang.Object obj)

Returns whether the specified object is equal to this. An object is equal to this if it is also a Contact and its email addresses is equal to this contact's email address.

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

true if the argument is a Contact and also has the same email address as this

hashCode

public int hashCode()

Returns a unique integer hash code for this contact.

Overrides:

hashCode in class java.lang.Object

Returns:

a integer hash code that represents this contact