rocks.xmpp.im.roster

Class RosterEvent

java.lang.Object

java.util.EventObject

rocks.xmpp.im.roster.RosterEvent

All Implemented Interfaces:

java.io.Serializable

public final class RosterEvent
extends java.util.EventObject

A roster event which holds information about added, updated and removed contacts of the roster.

This event is dispatched by the RosterManager, whenever a roster push or result is received.

This class is immutable.

See Also:

RosterManager.addRosterListener(Consumer), Serialized Form

Method Summary

Modifier and Type	Method and Description
java.util.List<Contact>	getAddedContacts() Gets the added contacts, which have been added since the last roster push or which have been initially set by the first roster result.
java.util.List<Contact>	getRemovedContacts() Gets the removed contacts, i.e. contacts which were on the roster, but now are no longer on the roster.
java.util.List<Contact>	getUpdatedContacts() Gets the updated contacts, i.e. if an existing contact has changed its name, groups or subscription state.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getAddedContacts

public final java.util.List<Contact> getAddedContacts()

Gets the added contacts, which have been added since the last roster push or which have been initially set by the first roster result.

Returns:

The added contacts.

getUpdatedContacts

public final java.util.List<Contact> getUpdatedContacts()

Gets the updated contacts, i.e. if an existing contact has changed its name, groups or subscription state.

Returns:

The updated contacts.

getRemovedContacts

public final java.util.List<Contact> getRemovedContacts()

Gets the removed contacts, i.e. contacts which were on the roster, but now are no longer on the roster.

Returns:

The removed contacts.