org.jivesoftware.smackx.bookmarks

Class BookmarkedConference

java.lang.Object

org.jivesoftware.smackx.bookmarks.BookmarkedConference

All Implemented Interfaces:

SharedBookmark

public class BookmarkedConference
extends Object
implements SharedBookmark

Respresents a Conference Room bookmarked on the server using XEP-0048 Bookmark Storage XEP.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BookmarkedConference(String jid)
protected	BookmarkedConference(String name, String jid, boolean autoJoin, String nickname, String password)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getJid() Returns the full JID of this conference room.
String	getName() Returns the display label representing the Conference room.
String	getNickname() Returns the nickname to use when joining this conference room.
String	getPassword() Returns the password to use when joining this conference room.
boolean	isAutoJoin() Returns true if this conference room should be auto-joined on startup.
boolean	isShared() Returns true if this bookmark is shared.
protected void	setAutoJoin(boolean autoJoin)
protected void	setName(String name)
protected void	setNickname(String nickname)
protected void	setPassword(String password)
protected void	setShared(boolean isShared)

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkedConference

protected BookmarkedConference(String jid)

BookmarkedConference

protected BookmarkedConference(String name,
                    String jid,
                    boolean autoJoin,
                    String nickname,
                    String password)

Method Detail

getName

public String getName()

Returns the display label representing the Conference room.

Returns:

the name of the conference room.

setName

protected void setName(String name)

isAutoJoin

public boolean isAutoJoin()

Returns true if this conference room should be auto-joined on startup.

Returns:

true if room should be joined on startup, otherwise false.

setAutoJoin

protected void setAutoJoin(boolean autoJoin)

getJid

public String getJid()

Returns the full JID of this conference room. (ex.dev@conference.jivesoftware.com)

Returns:

the full JID of this conference room.

getNickname

public String getNickname()

Returns the nickname to use when joining this conference room. This is an optional value and may return null.

Returns:

the nickname to use when joining, null may be returned.

setNickname

protected void setNickname(String nickname)

getPassword

public String getPassword()

Returns the password to use when joining this conference room. This is an optional value and may return null.

Returns:

the password to use when joining this conference room, null may be returned.

setPassword

protected void setPassword(String password)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

setShared

protected void setShared(boolean isShared)

isShared

public boolean isShared()

Description copied from interface: SharedBookmark

Returns true if this bookmark is shared.

Specified by:

isShared in interface SharedBookmark

Returns:

returns true if this bookmark is shared.