rocks.xmpp.extensions.muc.model.owner

Class MucOwner

java.lang.Object

rocks.xmpp.extensions.muc.model.owner.MucOwner

public final class MucOwner
extends java.lang.Object

The implementation of the <query/> element in the http://jabber.org/protocol/muc#owner namespace.

Usage

// To create an empty element (to query the configuration form).
MucOwner mucOwner = MucOwner.empty();

This class is immutable.

See Also:

XEP-0045: Multi-User Chat, XML Schema

Method Summary

Modifier and Type	Method and Description
static MucOwner	empty() Creates an empty query element.
DataForm	getConfigurationForm() Gets the configuration form.
Destroy	getDestroy() Gets the destroy element.
static MucOwner	withConfiguration(DataForm dataForm) Creates a <query/> element with a <x/> (data form) child element.
static MucOwner	withDestroy(Jid jid, java.lang.String reason) Creates a <query/> element with a <destroy/> child element.

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static MucOwner empty()

Creates an empty query element.

Returns:

The MucOwner instance.

withDestroy

public static MucOwner withDestroy(Jid jid,
                                   java.lang.String reason)

Creates a <query/> element with a <destroy/> child element.

Sample:

<query xmlns='http://jabber.org/protocol/muc#owner'>
    <destroy jid='coven@chat.shakespeare.lit'>
        <reason>Macbeth doth come.</reason>
    </destroy>
</query>

Parameters:

jid - The JID.

reason - The reason.

Returns:

The MucOwner instance.

withConfiguration

public static MucOwner withConfiguration(DataForm dataForm)

Creates a <query/> element with a <x/> (data form) child element.

Parameters:

dataForm - The configuration form.

Returns:

The MucOwner instance.

getConfigurationForm

public DataForm getConfigurationForm()

Gets the configuration form.

Returns:

The configuration form.

getDestroy

public Destroy getDestroy()

Gets the destroy element.

Returns:

The destroy element.