Package org.jivesoftware.smack.roster

Class RosterEntry

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smack.roster.RosterEntry

public final class RosterEntry
extends Manager

Each user in your roster is represented by a roster entry, which contains the user's JID and a name or nickname you assign.

Method Summary

Modifier and Type	Method	Description
void	cancelSubscription()	Cancel the presence subscription the XMPP entity representing this roster entry has with us.
boolean	canSeeHisPresence()	Check if we are subscribed to the contact's presence.
boolean	canSeeMyPresence()	Check if the contact is subscribed to "my" presence.
boolean	equals(Object object)
boolean	equalsDeep(Object obj)	Indicates whether some other object is "equal to" this by comparing all members.
List<RosterGroup>	getGroups()	Returns an copied list of the roster groups that this entry belongs to.
BareJid	getJid()	Returns the JID associated with this entry.
String	getName()	Returns the name associated with this entry.
RosterPacket.ItemType	getType()	Returns the roster subscription type of the entry.
String	getUser()	Deprecated. use getJid() instead.
int	hashCode()
boolean	isApproved()	Returns the pre-approval state of this entry.
boolean	isSubscriptionPending()	Returns the roster subscription request status of the entry.
void	setName(String name)	Sets the name associated with this entry.
String	toString()

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule, schedule, scheduleBlocking

Methods inherited from class java.lang.Object

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

Method Detail

getUser

@Deprecated
public String getUser()

Deprecated.

use getJid() instead.

Returns the JID of the user associated with this entry.

Returns:

the user associated with this entry.

getJid

public BareJid getJid()

Returns the JID associated with this entry.

Returns:

the user associated with this entry.

getName

public String getName()

Returns the name associated with this entry.

Returns:

the name.

setName

public void setName(String name)
             throws SmackException.NotConnectedException,
                    SmackException.NoResponseException,
                    XMPPException.XMPPErrorException,
                    InterruptedException

Sets the name associated with this entry.

Parameters:

name - the name.

Throws:

SmackException.NotConnectedException - if the XMPP connection is not connected.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

InterruptedException - if the calling thread was interrupted.

isApproved

public boolean isApproved()

Returns the pre-approval state of this entry.

Returns:

the pre-approval state.

getGroups

public List<RosterGroup> getGroups()

Returns an copied list of the roster groups that this entry belongs to.

Returns:

an iterator for the groups this entry belongs to.

getType

public RosterPacket.ItemType getType()

Returns the roster subscription type of the entry. When the type is RosterPacket.ItemType.none or RosterPacket.ItemType.from, refer to getStatus() to see if a subscription request is pending.

Returns:

the type.

isSubscriptionPending

public boolean isSubscriptionPending()

Returns the roster subscription request status of the entry. If true, then the contact did not answer the subscription request yet.

Returns:

the status.

Since:

4.2

canSeeMyPresence

public boolean canSeeMyPresence()

Check if the contact is subscribed to "my" presence. This allows the contact to see the presence information.

Returns:

true if the contact has a presence subscription.

Since:

4.2

canSeeHisPresence

public boolean canSeeHisPresence()

Check if we are subscribed to the contact's presence. If true then the contact has allowed us to receive presence information.

Returns:

true if we are subscribed to the contact's presence.

Since:

4.2

cancelSubscription

public void cancelSubscription()
                        throws SmackException.NotConnectedException,
                               InterruptedException

Cancel the presence subscription the XMPP entity representing this roster entry has with us.

Throws:

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

Since:

4.2

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

equalsDeep

public boolean equalsDeep(Object obj)

Indicates whether some other object is "equal to" this by comparing all members.

The equals(Object) method returns true if the user JIDs are equal.

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.