org.jivesoftware.smackx.disco.packet

Class DiscoverItems

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.disco.packet.DiscoverItems

public class DiscoverItems
extends IQ

A DiscoverItems IQ packet, which is used by XMPP clients to request and receive items associated with XMPP entities.

The items could also be queried in order to discover if they contain items inside. Some items may be addressable by its JID and others may require to be addressed by a JID and a node name.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiscoverItems.Item An item is associated with an XMPP Entity, usually thought of a children of the parent entity and normally are addressable as a JID.

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

IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE

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

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
DiscoverItems()

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(DiscoverItems.Item item) Adds a new item to the discovered information.
void	addItems(Collection<DiscoverItems.Item> itemsToAdd) Adds a collection of items to the discovered information.
XmlStringBuilder	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
List<DiscoverItems.Item>	getItems() Returns the discovered items of the queried XMPP entity.
String	getNode() Returns the node attribute that supplements the 'jid' attribute.
void	setNode(String node) Sets the node attribute that supplements the 'jid' attribute.

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, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

DiscoverItems

public DiscoverItems()

Method Detail

addItem

public void addItem(DiscoverItems.Item item)

Adds a new item to the discovered information.

Parameters:

item - the discovered entity's item

addItems

public void addItems(Collection<DiscoverItems.Item> itemsToAdd)

Adds a collection of items to the discovered information. Does nothing if itemsToAdd is null

Parameters:

itemsToAdd -

getItems

public List<DiscoverItems.Item> getItems()

Returns the discovered items of the queried XMPP entity.

Returns:

an unmodifiable list of the discovered entity's items

getNode

public String getNode()

Returns the node attribute that supplements the 'jid' attribute. A node is merely something that is associated with a JID and for which the JID can provide information.

Node attributes SHOULD be used only when trying to provide or query information which is not directly addressable.

Returns:

the node attribute that supplements the 'jid' attribute

setNode

public void setNode(String node)

Sets the node attribute that supplements the 'jid' attribute. A node is merely something that is associated with a JID and for which the JID can provide information.

Node attributes SHOULD be used only when trying to provide or query information which is not directly addressable.

Parameters:

node - the node attribute that supplements the 'jid' attribute

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.