Package org.jivesoftware.smackx.mam.element

Class MamPrefsIQ

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.mam.element.MamPrefsIQ

All Implemented Interfaces:

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

public class MamPrefsIQ
extends IQ

MAM Preferences IQ class.

See Also:

XEP-0313: Message Archive Management

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MamPrefsIQ.DefaultBehavior

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	the preferences element.
static String	NAMESPACE	the IQ 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
MamPrefsIQ()	Construct a new MAM <prefs/> IQ retrieval request (IQ type 'get').
MamPrefsIQ(List<Jid> alwaysJids, List<Jid> neverJids, MamPrefsIQ.DefaultBehavior defaultBehavior)	MAM preferences IQ constructor.

Method Summary

Modifier and Type	Method	Description
List<Jid>	getAlwaysJids()	Get the list of always store info JIDs.
MamPrefsIQ.DefaultBehavior	getDefault()	Get the default behavior.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)	This method must be overwritten by IQ subclasses to create their child content.
List<Jid>	getNeverJids()	Get the list of never store info JIDs.

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

the preferences element.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

the IQ NAMESPACE.

See Also:

Constant Field Values

Constructor Detail

MamPrefsIQ

public MamPrefsIQ()

Construct a new MAM <prefs/> IQ retrieval request (IQ type 'get').

MamPrefsIQ

public MamPrefsIQ(List<Jid> alwaysJids,
                  List<Jid> neverJids,
                  MamPrefsIQ.DefaultBehavior defaultBehavior)

MAM preferences IQ constructor.

Parameters:

alwaysJids - TODO javadoc me please

neverJids - TODO javadoc me please

defaultBehavior - TODO javadoc me please

Method Detail

getAlwaysJids

public List<Jid> getAlwaysJids()

Get the list of always store info JIDs.

Returns:

the always list

getNeverJids

public List<Jid> getNeverJids()

Get the list of never store info JIDs.

Returns:

the never list

getDefault

public MamPrefsIQ.DefaultBehavior getDefault()

Get the default behavior.

Returns:

the default behavior.

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.