org.jivesoftware.smackx.disco.packet

Class DiscoverInfo

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.disco.packet.DiscoverInfo

All Implemented Interfaces:

Cloneable, Element, Packet, TopLevelStreamElement, TypedCloneable<DiscoverInfo>

public class DiscoverInfo
extends IQ
implements TypedCloneable<DiscoverInfo>

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.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

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

IQ_ELEMENT, QUERY_ELEMENT

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

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
DiscoverInfo()
DiscoverInfo(DiscoverInfo d) Copy constructor

Method Summary

Modifier and Type	Method and Description
boolean	addFeature(DiscoverInfo.Feature feature)
boolean	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() Clone this instance.
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.
List<DiscoverInfo.Feature>	getFeatures() Returns the discovered features of an XMPP entity.
List<DiscoverInfo.Identity>	getIdentities() Returns the discovered identities of an XMPP entity.
List<DiscoverInfo.Identity>	getIdentities(String category, String type) Returns all Identities of the given category and type of this DiscoverInfo.
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml) This method must be overwritten by IQ subclasses to create their child content.
String	getNode() Returns the node attribute that supplements the 'jid' attribute.
boolean	hasIdentity(String category, String type) Returns true if this DiscoverInfo contains at least one Identity of the given category and type.
void	setNode(String node) Sets the node attribute that supplements the 'jid' attribute.

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

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

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, overrideExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, setStanzaId, setTo, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

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 boolean addFeature(String feature)

Adds a new feature to the discovered information.

Parameters:

feature - the discovered feature

Returns:

true if the feature did not already exist.

addFeatures

public void addFeatures(Collection<String> featuresToAdd)

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

Parameters:

featuresToAdd -

addFeature

public boolean addFeature(DiscoverInfo.Feature feature)

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

hasIdentity

public boolean hasIdentity(String category,
                           String type)

Returns true if this DiscoverInfo contains at least one Identity of the given category and type.

Parameters:

category - the category to look for.

type - the type to look for.

Returns:

true if this DiscoverInfo contains a Identity of the given category and type.

getIdentities

public List<DiscoverInfo.Identity> getIdentities(String category,
                                                 String type)

Returns all Identities of the given category and type of this DiscoverInfo.

Parameters:

category - category the category to look for.

type - type the type to look for.

Returns:

a list of Identites with the given category and type.

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

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)

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

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

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

Returns:

the build to create the IQ child content.

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()

Description copied from interface: TypedCloneable

Clone this instance.

Specified by:

clone in interface TypedCloneable<DiscoverInfo>

Overrides:

clone in class Object

Returns:

a cloned version of this instance.