org.jivesoftware.smack
Class RosterTest.TestRosterListener

java.lang.Object
  extended by org.jivesoftware.smack.RosterTest.TestRosterListener
All Implemented Interfaces:
RosterListener
Enclosing class:
RosterTest

public static class RosterTest.TestRosterListener
extends java.lang.Object
implements RosterListener

This class can be used to check if the RosterListener was invoked.


Constructor Summary
RosterTest.TestRosterListener()
           
 
Method Summary
 void entriesAdded(java.util.Collection<java.lang.String> addresses)
          Called when roster entries are added.
 void entriesDeleted(java.util.Collection<java.lang.String> addresses)
          Called when a roster entries are removed.
 void entriesUpdated(java.util.Collection<java.lang.String> addresses)
          Called when a roster entries are updated.
 java.util.Collection<java.lang.String> getAddedAddresses()
          Get a collection of JIDs of the added roster items.
 java.util.Collection<java.lang.String> getDeletedAddresses()
          Get a collection of JIDs of the deleted roster items.
 java.util.Collection<java.lang.String> getUpdatedAddresses()
          Get a collection of JIDs of the updated roster items.
 void presenceChanged(Presence presence)
          Called when the presence of a roster entry is changed.
 void reset()
          Reset the lists of added, deleted or updated items.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RosterTest.TestRosterListener

public RosterTest.TestRosterListener()
Method Detail

entriesAdded

public void entriesAdded(java.util.Collection<java.lang.String> addresses)
Description copied from interface: RosterListener
Called when roster entries are added.

Specified by:
entriesAdded in interface RosterListener
Parameters:
addresses - the XMPP addresses of the contacts that have been added to the roster.

entriesDeleted

public void entriesDeleted(java.util.Collection<java.lang.String> addresses)
Description copied from interface: RosterListener
Called when a roster entries are removed.

Specified by:
entriesDeleted in interface RosterListener
Parameters:
addresses - the XMPP addresses of the contacts that have been removed from the roster.

entriesUpdated

public void entriesUpdated(java.util.Collection<java.lang.String> addresses)
Description copied from interface: RosterListener
Called when a roster entries are updated.

Specified by:
entriesUpdated in interface RosterListener
Parameters:
addresses - the XMPP addresses of the contacts whose entries have been updated.

presenceChanged

public void presenceChanged(Presence presence)
Description copied from interface: RosterListener
Called when the presence of a roster entry is changed. Care should be taken when using the presence data delivered as part of this event. Specifically, when a user account is online with multiple resources, the UI should account for that. For example, say a user is online with their desktop computer and mobile phone. If the user logs out of the IM client on their mobile phone, the user should not be shown in the roster (contact list) as offline since they're still available as another resource.

To get the current "best presence" for a user after the presence update, query the roster:

    String user = presence.getFrom();
    Presence bestPresence = roster.getPresence(user);
 
That will return the presence value for the user with the highest priority and availability. Note that this listener is triggered for presence (mode) changes only (e.g presence of types available and unavailable. Subscription-related presence packets will not cause this method to be called.

Specified by:
presenceChanged in interface RosterListener
Parameters:
presence - the presence that changed.
See Also:
Roster.getPresence(String)

getAddedAddresses

public java.util.Collection<java.lang.String> getAddedAddresses()
Get a collection of JIDs of the added roster items.

Returns:
the collection of addresses which were added.

getDeletedAddresses

public java.util.Collection<java.lang.String> getDeletedAddresses()
Get a collection of JIDs of the deleted roster items.

Returns:
the collection of addresses which were deleted.

getUpdatedAddresses

public java.util.Collection<java.lang.String> getUpdatedAddresses()
Get a collection of JIDs of the updated roster items.

Returns:
the collection of addresses which were updated.

reset

public void reset()
Reset the lists of added, deleted or updated items.