rocks.xmpp.core.roster.model

Class Contact

java.lang.Object

rocks.xmpp.core.roster.model.Contact

All Implemented Interfaces:

Comparable<Contact>

public final class Contact
extends Object
implements Comparable<Contact>

A contact in the user's roster.

2.1.2. Roster Items

The <query/> element inside a roster set contains one <item/> child, and a roster result typically contains multiple <item/> children. Each <item/> element describes a unique "roster item" (sometimes also called a "contact").

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Contact.Subscription The implementation of the 'subscription' attribute.

Constructor Summary

Constructors

Constructor and Description
Contact(Jid jid) Creates a new contact associated with the given JID.
Contact(Jid jid, String name) Creates a new contact associated with the given JID and name.
Contact(Jid jid, String name, boolean isPending, Contact.Subscription subscription, String... groups) Creates a new contact associated with the given JID, name and groups.
Contact(Jid jid, String name, List<String> groups) Creates a new contact associated with the given JID, name and groups.
Contact(Jid jid, String name, String... groups) Creates a new contact associated with the given JID, name and groups.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Contact o) Compares two contacts with each other by first comparing their names, then their subscription states and eventually their pending states.
boolean	equals(Object o)
List<String>	getGroups() Gets the groups of the contact.
Jid	getJid() Gets the JID of the contact.
String	getName() Gets the name of the contact.
Contact.Subscription	getSubscription() Gets the subscription attribute.
int	hashCode()
boolean	isApproved() Gets the subscription pre-approval status.
boolean	isPending() Gets the pending state of the contact.
void	setName(String name) Sets the name of the contact.
void	setSubscription(Contact.Subscription subscription) Sets the subscription state of the contact.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Contact

public Contact(Jid jid)

Creates a new contact associated with the given JID.

Parameters:

jid - The JID.

Contact

public Contact(Jid jid,
               String name)

Creates a new contact associated with the given JID and name.

Parameters:

jid - The JID.

name - The name.

Contact

public Contact(Jid jid,
               String name,
               String... groups)

Creates a new contact associated with the given JID, name and groups.

Parameters:

jid - The JID.

name - The name.

groups - The groups for this contact.

Contact

public Contact(Jid jid,
               String name,
               List<String> groups)

Creates a new contact associated with the given JID, name and groups.

Parameters:

jid - The JID.

name - The name.

groups - The groups for this contact.

Contact

public Contact(Jid jid,
               String name,
               boolean isPending,
               Contact.Subscription subscription,
               String... groups)

Creates a new contact associated with the given JID, name and groups.

Parameters:

jid - The JID.

name - The name.

isPending - Indicates, whether the contact's subscription approval is pending.

subscription - The subscription.

groups - The groups for this contact.

Method Detail

getJid

public Jid getJid()

Gets the JID of the contact.

Returns:

The JID.

getName

public String getName()

Gets the name of the contact.

Returns:

The name.

See Also:

setName(String)

setName

public void setName(String name)

Sets the name of the contact.

2.1.2.4. Name Attribute

The 'name' attribute of the <item/> element specifies the "handle" to be associated with the JID, as determined by the user (not the contact). Although the value of the 'name' attribute MAY have meaning to a human user, it is opaque to the server. However, the 'name' attribute MAY be used by the server for matching purposes within the context of various XMPP extensions (one possible comparison method is that described for XMPP resourceparts in [XMPP-ADDR]).

It is OPTIONAL for a client to include the 'name' attribute when adding or updating a roster item.

Parameters:

name - The name.

getSubscription

public Contact.Subscription getSubscription()

Gets the subscription attribute.

Returns:

The subscription attribute.

setSubscription

public void setSubscription(Contact.Subscription subscription)

Sets the subscription state of the contact. A client should only set Contact.Subscription.REMOVE as other states are managed via presence stanzas.

Parameters:

subscription - The subscription.

getGroups

public List<String> getGroups()

Gets the groups of the contact.

Returns:

The groups.

isPending

public boolean isPending()

Gets the pending state of the contact.

2.1.2.2. Ask Attribute

The 'ask' attribute of the <item/> element with a value of "subscribe" is used to signal various subscription sub-states that include a "Pending Out" aspect as described under Section 3.1.2.

A server SHOULD include the 'ask' attribute to inform the client of "Pending Out" sub-states. A client MUST NOT include the 'ask' attribute in the roster sets it sends to the server, but instead MUST use presence stanzas of type "subscribe" and "unsubscribe" to manage such sub-states as described under Section 3.1.2.

Returns:

True, if a subscription request for the contact is pending, i.e. the contact has not yet approved or denied a subscription request.

isApproved

public boolean isApproved()

Gets the subscription pre-approval status.

2.1.2.1. Approved Attribute

The boolean 'approved' attribute with a value of "true" is used to signal subscription pre-approval as described under Section 3.4

Returns:

True, if the contact is pre approved.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Contact o)

Compares two contacts with each other by first comparing their names, then their subscription states and eventually their pending states.

Specified by:

compareTo in interface Comparable<Contact>

Parameters:

o - The other contact.

Returns:

The result of the comparison.

toString

public String toString()

Overrides:

toString in class Object