org.jivesoftware.smack.packet

Class RosterPacket

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smack.packet.RosterPacket

All Implemented Interfaces:

Element, TopLevelStreamElement

public class RosterPacket
extends IQ

Represents XMPP roster packets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RosterPacket.Item A roster item, which consists of a JID, their name, the type of subscription, and the groups the roster item belongs to.
static class	RosterPacket.ItemStatus The subscription status of a roster item.
static class	RosterPacket.ItemType

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 java.lang.String	ELEMENT
static java.lang.String	NAMESPACE

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

IQ_ELEMENT, QUERY_ELEMENT, type

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

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
RosterPacket()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRosterItem(RosterPacket.Item item) Adds a roster item to the packet.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf) This method must be overwritten by IQ subclasses to create their child content.
int	getRosterItemCount() Returns the number of roster items in this roster packet.
java.util.List<RosterPacket.Item>	getRosterItems() Returns a copied list of the roster items in the packet.
java.lang.String	getVersion()
void	setVersion(java.lang.String version)

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

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

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getTo, hasExtension, hasExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, 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 java.lang.String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

RosterPacket

public RosterPacket()

Method Detail

addRosterItem

public void addRosterItem(RosterPacket.Item item)

Adds a roster item to the packet.

Parameters:

item - a roster item.

getRosterItemCount

public int getRosterItemCount()

Returns the number of roster items in this roster packet.

Returns:

the number of roster items.

getRosterItems

public java.util.List<RosterPacket.Item> getRosterItems()

Returns a copied list of the roster items in the packet.

Returns:

a copied list of the roster items in the packet.

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf)

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 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 packet extensions), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

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

Returns:

the build to create the IQ child content.

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)