org.jivesoftware.smack.packet

Class RosterPacket

java.lang.Object

org.jivesoftware.smack.packet.TopLevelStreamElement

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smack.packet.RosterPacket

All Implemented Interfaces:

Element

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.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

QUERY_ELEMENT

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.
XmlStringBuilder	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
int	getRosterItemCount() Returns the number of roster items in this roster packet.
java.util.Collection<RosterPacket.Item>	getRosterItems() Returns an unmodifiable collection for 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, getType, setType, toXML

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

addCommonAttributes, addExtension, addExtensions, 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.Collection<RosterPacket.Item> getRosterItems()

Returns an unmodifiable collection for the roster items in the packet.

Returns:

an unmodifiable collection for the roster items in the packet.

getChildElementXML

public XmlStringBuilder getChildElementXML()

Description copied from class: IQ

Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:

getChildElementXML in class IQ

Returns:

the child element section of the IQ XML.

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)