org.jivesoftware.smackx.disco.packet

Class DiscoverInfo

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.disco.packet.DiscoverInfo

All Implemented Interfaces:

Cloneable

public class DiscoverInfo
extends IQ
implements Cloneable

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.

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

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
DiscoverInfo()
DiscoverInfo(DiscoverInfo d) Copy constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addFeature(String feature) Adds a new feature to the discovered information.
void	addFeatures(Collection<String> featuresToAdd) Adds a collection of features to the packet.
void	addIdentities(Collection<DiscoverInfo.Identity> identitiesToAdd) Adds identities to the DiscoverInfo stanza
void	addIdentity(DiscoverInfo.Identity identity) Adds a new identity of the requested entity to the discovered information.
DiscoverInfo	clone()
boolean	containsDuplicateFeatures() Test if a DiscoverInfo response contains duplicate features.
boolean	containsDuplicateIdentities() Test if a DiscoverInfo response contains duplicate identities.
boolean	containsFeature(String feature) Returns true if the specified feature is part of the discovered information.
CharSequence	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
List<DiscoverInfo.Feature>	getFeatures() Returns the discovered features of an XMPP entity.
List<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

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

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

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

DiscoverInfo

public DiscoverInfo()

DiscoverInfo

public DiscoverInfo(DiscoverInfo d)

Copy constructor

Parameters:

d -

Method Detail

addFeature

public void addFeature(String feature)

Adds a new feature to the discovered information.

Parameters:

feature - the discovered feature

addFeatures

public void addFeatures(Collection<String> featuresToAdd)

Adds a collection of features to the packet. Does noting if featuresToAdd is null.

Parameters:

featuresToAdd -

getFeatures

public List<DiscoverInfo.Feature> getFeatures()

Returns the discovered features of an XMPP entity.

Returns:

an unmodifiable list of 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

addIdentities

public void addIdentities(Collection<DiscoverInfo.Identity> identitiesToAdd)

Adds identities to the DiscoverInfo stanza

Parameters:

identitiesToAdd -

getIdentities

public List<DiscoverInfo.Identity> getIdentities()

Returns the discovered identities of an XMPP entity.

Returns:

an unmodifiable list of the discovered 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 CharSequence 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.

containsDuplicateIdentities

public boolean containsDuplicateIdentities()

Test if a DiscoverInfo response contains duplicate identities.

Returns:

true if duplicate identities where found, otherwise false

containsDuplicateFeatures

public boolean containsDuplicateFeatures()

Test if a DiscoverInfo response contains duplicate features.

Returns:

true if duplicate identities where found, otherwise false

clone

public DiscoverInfo clone()

Overrides:

clone in class Object