rocks.xmpp.extensions.bookmarks

Class BookmarkManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.session.ExtensionManager

rocks.xmpp.extensions.bookmarks.BookmarkManager

public final class BookmarkManager
extends ExtensionManager

This manager facilitates the access to the private storage by providing convenient method for adding, retrieving or removing bookmarks.

Author:

Christian Schudt

Field Summary

Fields inherited from class rocks.xmpp.core.session.ExtensionManager

features, xmppSession

Method Summary

Modifier and Type	Method and Description
void	addBookmark(Bookmark bookmark) Adds a bookmark.
Collection<ChatRoomBookmark>	getChatRoomBookmarks() Gets a sorted collection of chat room bookmarks.
Collection<WebPageBookmark>	getWebPageBookmarks() Gets a sorted collection of web page bookmarks.
void	removeChatRoomBookmark(rocks.xmpp.core.Jid chatRoom) Removes a chat room bookmark.
void	removeWebPageBookmark(URL webPage) Removes a web page bookmark.

Methods inherited from class rocks.xmpp.core.session.ExtensionManager

setEnabled

Methods inherited from class rocks.xmpp.core.session.Manager

isEnabled

Methods inherited from class java.lang.Object

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

Method Detail

getChatRoomBookmarks

public Collection<ChatRoomBookmark> getChatRoomBookmarks()
                                                  throws rocks.xmpp.core.XmppException

Gets a sorted collection of chat room bookmarks.

Returns:

The chat room bookmarks.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

getWebPageBookmarks

public Collection<WebPageBookmark> getWebPageBookmarks()
                                                throws rocks.xmpp.core.XmppException

Gets a sorted collection of web page bookmarks.

Returns:

The web page bookmarks.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

addBookmark

public void addBookmark(Bookmark bookmark)
                 throws rocks.xmpp.core.XmppException

Adds a bookmark.

Parameters:

bookmark - The bookmark.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

removeChatRoomBookmark

public void removeChatRoomBookmark(rocks.xmpp.core.Jid chatRoom)
                            throws rocks.xmpp.core.XmppException

Removes a chat room bookmark.

Parameters:

chatRoom - The chat room.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

removeWebPageBookmark

public void removeWebPageBookmark(URL webPage)
                           throws rocks.xmpp.core.XmppException

Removes a web page bookmark.

Parameters:

webPage - The web page.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException