org.jivesoftware.smackx.muc.packet

Class MUCOwner

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.muc.packet.MUCOwner

All Implemented Interfaces:

Element, Packet, TopLevelStreamElement

public class MUCOwner
extends IQ

IQ stanza(/packet) that serves for granting and revoking ownership privileges, granting and revoking administrative privileges and destroying a room. All these operations are scoped by the 'http://jabber.org/protocol/muc#owner' namespace.

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

Fields inherited from class org.jivesoftware.smack.packet.IQ

IQ_ELEMENT, QUERY_ELEMENT

Fields inherited from class org.jivesoftware.smack.packet.Stanza

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
MUCOwner()

Method Summary

Modifier and Type	Method and Description
void	addItem(MUCItem item) Adds an item child that holds information about affiliation, jids and nicks.
Destroy	getDestroy() Returns a request to the server to destroy a room.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml) This method must be overwritten by IQ subclasses to create their child content.
List<MUCItem>	getItems() Returns a List of item childs that holds information about affiliation, jids and nicks.
void	setDestroy(Destroy destroy) Sets a request to the server to destroy a room.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getType, isRequestIQ, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Stanza

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, overrideExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, setStanzaId, setTo, toString

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

MUCOwner

public MUCOwner()

Method Detail

getItems

public List<MUCItem> getItems()

Returns a List of item childs that holds information about affiliation, jids and nicks.

Returns:

a List of item childs that holds information about affiliation, jids and nicks.

getDestroy

public Destroy getDestroy()

Returns a request to the server to destroy a room. The sender of the request should be the room's owner. If the sender of the destroy request is not the room's owner then the server will answer a "Forbidden" error.

Returns:

a request to the server to destroy a room.

setDestroy

public void setDestroy(Destroy destroy)

Sets a request to the server to destroy a room. The sender of the request should be the room's owner. If the sender of the destroy request is not the room's owner then the server will answer a "Forbidden" error.

Parameters:

destroy - the request to the server to destroy a room.

addItem

public void addItem(MUCItem item)

Adds an item child that holds information about affiliation, jids and nicks.

Parameters:

item - the item child that holds information about affiliation, jids and nicks.

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important that the builder does not include the final end element. This will be done automatically by IQChildelementXmlStringBuilder after eventual existing stanza(/packet) extensions have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides stanza(/packet) extensions), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

xml - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.