org.jivesoftware.smack

Class DefaultRosterStore

java.lang.Object

org.jivesoftware.smack.DefaultRosterStore

All Implemented Interfaces:

RosterStore

public class DefaultRosterStore
extends Object
implements RosterStore

Stores roster entries as specified by RFC 6121 for roster versioning in a set of files.

Author:

Lars Noschinski, Fabian Schuetz

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEntry(org.xmpp.packet.Roster.Item item, String version) This method stores a new roster entry in this store or updates an existing one.
List<org.xmpp.packet.Roster.Item>	getEntries() This method returns a collection of all roster items contained in this store.
org.xmpp.packet.Roster.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.
static DefaultRosterStore	init(File baseDir) Creates a new roster store on disk
static DefaultRosterStore	open(File baseDir) Opens a roster store
boolean	removeEntry(String bareJid, String version) Removes an entry from the store
boolean	resetEntries(Collection<org.xmpp.packet.Roster.Item> items, String version) This method updates the store so that it contains only the given entries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

init

public static DefaultRosterStore init(File baseDir)

Creates a new roster store on disk

Parameters:

baseDir - The directory to create the store in. The directory should be empty

Returns:

A DefaultRosterStore instance if successful, null else.

open

public static DefaultRosterStore open(File baseDir)

Opens a roster store

Parameters:

baseDir - The directory containing the roster store.

Returns:

A DefaultRosterStore instance if successful, null else.

getEntries

public List<org.xmpp.packet.Roster.Item> getEntries()

Description copied from interface: RosterStore

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

Specified by:

getEntries in interface RosterStore

Returns:

List of RosterEntry

getEntry

public org.xmpp.packet.Roster.Item getEntry(String bareJid)

Description copied from interface: RosterStore

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

Specified by:

getEntry in interface RosterStore

Parameters:

bareJid - The bare JID of the RosterEntry

Returns:

The RosterEntry which belongs to that user

getRosterVersion

public String getRosterVersion()

Description copied from interface: RosterStore

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.

Specified by:

getRosterVersion in interface RosterStore

Returns:

local roster version

addEntry

public boolean addEntry(org.xmpp.packet.Roster.Item item,
               String version)

Description copied from interface: RosterStore

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

Specified by:

addEntry in interface RosterStore

Parameters:

item - the entry to store

version - the new roster version

Returns:

True if successful

removeEntry

public boolean removeEntry(String bareJid,
                  String version)

Description copied from interface: RosterStore

Removes an entry from the store

Specified by:

removeEntry in interface RosterStore

Parameters:

bareJid - The bare JID of the entry to be removed

version - the new roster version

Returns:

True if successful

resetEntries

public boolean resetEntries(Collection<org.xmpp.packet.Roster.Item> items,
                   String version)

Description copied from interface: RosterStore

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

Specified by:

resetEntries in interface RosterStore

Parameters:

items - the entries to store

version - the new roster version

Returns:

True if successful