org.jivesoftware.smackx.packet

Class DiscoverInfo

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.packet.DiscoverInfo

public class DiscoverInfo
extends IQ

A DiscoverInfo IQ packet, which is used by XMPP clients to request and receive information to/from other XMPP entities.

The received information may contain one or more identities of the requested XMPP entity, and a list of supported features by the requested XMPP entity.

Author:

Gaston Dombiak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiscoverInfo.Feature Represents the features offered by the item.
static class	DiscoverInfo.Identity Represents the identity of a given XMPP entity.

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

IQ.Type

Field Summary

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

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
DiscoverInfo()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFeature(String feature) Adds a new feature to the discovered information.
void	addIdentity(DiscoverInfo.Identity identity) Adds a new identity of the requested entity to the discovered information.
boolean	containsFeature(String feature) Returns true if the specified feature is part of the discovered information.
String	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
Iterator<DiscoverInfo.Feature>	getFeatures() Returns the discovered features of an XMPP entity.
Iterator<DiscoverInfo.Identity>	getIdentities() Returns the discovered identities of an 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

addExtension, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoverInfo

public DiscoverInfo()

Method Detail

addFeature

public void addFeature(String feature)

Adds a new feature to the discovered information.

Parameters:

feature - the discovered feature

getFeatures

public Iterator<DiscoverInfo.Feature> getFeatures()

Returns the discovered features of an XMPP entity.

Returns:

an Iterator on the discovered features of an XMPP entity

addIdentity

public void addIdentity(DiscoverInfo.Identity identity)

Adds a new identity of the requested entity to the discovered information.

Parameters:

identity - the discovered entity's identity

getIdentities

public Iterator<DiscoverInfo.Identity> getIdentities()

Returns the discovered identities of an XMPP entity.

Returns:

an Iterator on the discoveted identities

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

containsFeature

public boolean containsFeature(String feature)

Returns true if the specified feature is part of the discovered information.

Parameters:

feature - the feature to check

Returns:

true if the requestes feature has been discovered

getChildElementXML

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