org.jivesoftware.smack.roster.rosterstore

Interface RosterStore

All Known Implementing Classes:

DirectoryRosterStore

public interface RosterStore

This is an interface for persistent roster store needed to implement roster versioning as per RFC 6121.

Method Summary

Modifier and Type	Method and Description
boolean	addEntry(RosterPacket.Item item, String version) This method stores a new roster entry in this store or updates an existing one.
Collection<RosterPacket.Item>	getEntries() This method returns a collection of all roster items contained in this store.
RosterPacket.Item	getEntry(String bareJid) This method returns the roster item in this store for the given JID.
String	getRosterVersion() This method returns the version number as specified by the "ver" attribute of the local store.
boolean	removeEntry(String bareJid, String version) Removes an entry from the store
boolean	resetEntries(Collection<RosterPacket.Item> items, String version) This method updates the store so that it contains only the given entries.

Method Detail

getEntries

Collection<RosterPacket.Item> getEntries()

This method returns a collection of all roster items contained in this store.

Returns:

List of RosterEntry

getEntry

RosterPacket.Item getEntry(String bareJid)

This method returns the roster item in this store for the given JID.

Parameters:

bareJid - The bare JID of the RosterEntry

Returns:

The RosterEntry which belongs to that user

getRosterVersion

String getRosterVersion()

This method returns the version number as specified by the "ver" attribute of the local store. For a fresh store, this MUST be the empty string.

Returns:

local roster version

addEntry

boolean addEntry(RosterPacket.Item item,
                 String version)

This method stores a new roster entry in this store or updates an existing one.

Parameters:

item - the entry to store

version - the new roster version

Returns:

True if successful

resetEntries

boolean resetEntries(Collection<RosterPacket.Item> items,
                     String version)

This method updates the store so that it contains only the given entries.

Parameters:

items - the entries to store

version - the new roster version

Returns:

True if successful

removeEntry

boolean removeEntry(String bareJid,
                    String version)

Removes an entry from the store

Parameters:

bareJid - The bare JID of the entry to be removed

version - the new roster version

Returns:

True if successful