vanitasvitae
/
Smack
mirror of https://github.com/vanitasvitae/Smack.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Improve style of RosterStore

This commit is contained in:
Florian Schmaus 2018-08-21 13:33:45 +02:00
parent 0e847f34f3
commit 24267c532d
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/RosterStore.java
View File

@ -39,32 +39,41 @@ public interface RosterStore {
/** /**
* This method returns the roster item in this store for the given JID. * This method returns the roster item in this store for the given JID.
*
* @param bareJid The bare JID of the RosterEntry * @param bareJid The bare JID of the RosterEntry
* @return The {@link org.jivesoftware.smack.roster.RosterEntry} which belongs to that user * @return The {@link org.jivesoftware.smack.roster.RosterEntry} which belongs to that user
*/ */
RosterPacket.Item getEntry(Jid bareJid); RosterPacket.Item getEntry(Jid bareJid);
/** /**
* This method returns the version number as specified by the "ver" attribute * 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. * of the local store. For a fresh store, this MUST be the empty string.
*
* @return local roster version * @return local roster version
*/ */
String getRosterVersion(); String getRosterVersion();
/** /**
* This method stores a new roster entry in this store or updates an existing one. * This method stores a new roster entry in this store or updates an existing one.
*
* @param item the entry to store * @param item the entry to store
* @param version the new roster version * @param version the new roster version
* @return True if successful * @return True if successful
*/ */
boolean addEntry(RosterPacket.Item item, String version); boolean addEntry(RosterPacket.Item item, String version);
/** /**
* This method updates the store so that it contains only the given entries. * This method updates the store so that it contains only the given entries.
*
* @param items the entries to store * @param items the entries to store
* @param version the new roster version * @param version the new roster version
* @return True if successful * @return True if successful
*/ */
boolean resetEntries(Collection<RosterPacket.Item> items, String version); boolean resetEntries(Collection<RosterPacket.Item> items, String version);
/** /**
* Removes an entry from the store. * Removes an entry from the store.
*
* @param bareJid The bare JID of the entry to be removed * @param bareJid The bare JID of the entry to be removed
* @param version the new roster version * @param version the new roster version
* @return True if successful * @return True if successful