rocks.xmpp.extensions.muc.model

Class Muc

java.lang.Object

rocks.xmpp.extensions.muc.model.Muc

public final class Muc
extends Object

The implementation of the <x/> element in the http://jabber.org/protocol/muc namespace, which allows to enter a room.

Usage

 
 // To create an empty element, e.g to indicate support in a presence
 Muc muc = Muc.empty();

 // To create an element with a password.
 Muc muc  = Muc.withPassword("secret");
 
 

This class is immutable.

See Also:

XEP-0045: Multi-User Chat, XML Schema

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE http://jabber.org/protocol/muc

Method Summary

Modifier and Type	Method and Description
static Muc	empty() Creates an empty element.
String	toString()
static Muc	withHistory(DiscussionHistory discussionHistory) Creates an element with a history element, indicating the user wishes to retrieve history.
static Muc	withPassword(String password) Creates an element with a password for the room.
static Muc	withPasswordAndHistory(String password, DiscussionHistory discussionHistory) Creates an element with a history element and a password for the room.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NAMESPACE

public static final String NAMESPACE

http://jabber.org/protocol/muc

See Also:

Constant Field Values

Method Detail

empty

public static Muc empty()

Creates an empty element.

Returns:

The MUC element.

withPassword

public static Muc withPassword(String password)

Creates an element with a password for the room.

Parameters:

password - The password.

Returns:

The MUC element.

withHistory

public static Muc withHistory(DiscussionHistory discussionHistory)

Creates an element with a history element, indicating the user wishes to retrieve history.

Parameters:

discussionHistory - The history.

Returns:

The MUC element.

withPasswordAndHistory

public static Muc withPasswordAndHistory(String password,
                                         DiscussionHistory discussionHistory)

Creates an element with a history element and a password for the room.

Parameters:

password - The password.

discussionHistory - The history.

Returns:

The MUC element.

toString

public final String toString()

Overrides:

toString in class Object