Package org.jivesoftware.smackx.muclight.element

Class MUCLightCreateIQ

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.muclight.element.MUCLightCreateIQ

All Implemented Interfaces:

Element, FullyQualifiedElement, IqView, NamedElement, StanzaView, TopLevelStreamElement, XmlLangElement

public class MUCLightCreateIQ
extends IQ

MUCLight create IQ class.

Nested Class Summary

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

IQ.IQChildElementXmlStringBuilder, IQ.ResponseType, IQ.Type

Field Summary

Fields

Modifier and Type	Field	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	Description
MUCLightCreateIQ(EntityJid room, String roomName, String subject, HashMap<String,String> customConfigs, List<Jid> occupants)	MUCLight create IQ constructor.
MUCLightCreateIQ(EntityJid room, String roomName, List<Jid> occupants)	MUCLight create IQ constructor.

Method Summary

Modifier and Type	Method	Description
MUCLightRoomConfiguration	getConfiguration()	Get the room configuration.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)	This method must be overwritten by IQ subclasses to create their child content.
HashMap<Jid,MUCLightAffiliation>	getOccupants()	Get the room occupants.

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

createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, isRequestIQ, isResponseIQ, setType, toString, toXML

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setLanguage, setNewStanzaId, setStanzaId, setStanzaId, setTo, throwIfNoStanzaId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

getQName

Methods inherited from interface org.jivesoftware.smack.packet.StanzaView

getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension

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

MUCLightCreateIQ

public MUCLightCreateIQ(EntityJid room,
                        String roomName,
                        String subject,
                        HashMap<String,String> customConfigs,
                        List<Jid> occupants)

MUCLight create IQ constructor.

Parameters:

room - TODO javadoc me please

roomName - TODO javadoc me please

subject - TODO javadoc me please

customConfigs - TODO javadoc me please

occupants - TODO javadoc me please

MUCLightCreateIQ

public MUCLightCreateIQ(EntityJid room,
                        String roomName,
                        List<Jid> occupants)

MUCLight create IQ constructor.

Parameters:

room - TODO javadoc me please

roomName - TODO javadoc me please

occupants - TODO javadoc me please

Method Detail

getConfiguration

public MUCLightRoomConfiguration getConfiguration()

Get the room configuration.

Returns:

the room configuration

getOccupants

public HashMap<Jid,MUCLightAffiliation> getOccupants()

Get the room occupants.

Returns:

the room occupants

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 you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements 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 ExtensionElements), 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.