Package 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:

Element, FullyQualifiedElement, IqView, NamedElement, StanzaView, TopLevelStreamElement, XmlLangElement, DiscoverInfoView

public class DiscoverInfo
extends IQ
implements DiscoverInfoView

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

Field Summary

Fields

Modifier and Type	Field	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	Description
DiscoverInfo()	Deprecated. use DiscoverInfoBuilder instead.
DiscoverInfo(DiscoverInfo d)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
boolean	addFeature(String feature)	Deprecated. use DiscoverInfoBuilder.addFeature(String) instead.
boolean	addFeature(DiscoverInfo.Feature feature)	Deprecated. use DiscoverInfoBuilder.addFeature(DiscoverInfo.Feature) instead.
void	addFeatures(Collection<String> featuresToAdd)	Deprecated. use DiscoverInfoBuilder.addFeatures(Collection) instead.
void	addIdentities(Collection<DiscoverInfo.Identity> identitiesToAdd)	Deprecated. use DiscoverInfoBuilder.addIdentities(Collection) instead.
void	addIdentity(DiscoverInfo.Identity identity)	Deprecated. use DiscoverInfoBuilder.addIdentity(DiscoverInfo.Identity) instead.
DiscoverInfoBuilder	asBuilder(String stanzaId)
static DiscoverInfoBuilder	builder(String stanzaId)
static DiscoverInfoBuilder	builder(IqData iqData)
static DiscoverInfoBuilder	builder(XMPPConnection connection)
DiscoverInfo	clone()	Deprecated. use asBuilder(String) instead.
boolean	containsDuplicateFeatures()	Test if a DiscoverInfo response contains duplicate features.
boolean	containsDuplicateIdentities()	Test if a DiscoverInfo response contains duplicate identities.
boolean	containsFeature(CharSequence 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)	Deprecated. use DiscoverInfoBuilder.setNode(String) instead.

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

createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, isRequestIQ, isResponseIQ, setType, toString, toXML

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setLanguage, setNewStanzaId, setStanzaId, setStanzaId, setTo, throwIfNoStanzaId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

getQName

Methods inherited from interface org.jivesoftware.smack.packet.IqView

getType

Methods inherited from interface org.jivesoftware.smack.packet.StanzaView

getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension

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

@Deprecated
public DiscoverInfo()

Deprecated.

use DiscoverInfoBuilder instead.

Deprecated.

DiscoverInfo

public DiscoverInfo(DiscoverInfo d)

Copy constructor.

Parameters:

d - TODO javadoc me please

Method Detail

addFeature

@Deprecated
public boolean addFeature(String feature)

Deprecated.

use DiscoverInfoBuilder.addFeature(String) instead.

Adds a new feature to the discovered information.

Parameters:

feature - the discovered feature

Returns:

true if the feature did not already exist.

addFeatures

@Deprecated
public void addFeatures(Collection<String> featuresToAdd)

Deprecated.

use DiscoverInfoBuilder.addFeatures(Collection) instead.

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

Parameters:

featuresToAdd - TODO javadoc me please

addFeature

@Deprecated
public boolean addFeature(DiscoverInfo.Feature feature)

Deprecated.

use DiscoverInfoBuilder.addFeature(DiscoverInfo.Feature) instead.

Deprecated.

Parameters:

feature - the future.

Returns:

true if the feature is new.

getFeatures

public List<DiscoverInfo.Feature> getFeatures()

Description copied from interface: DiscoverInfoView

Returns the discovered features of an XMPP entity.

Specified by:

getFeatures in interface DiscoverInfoView

Returns:

an unmodifiable list of the discovered features of an XMPP entity

addIdentity

@Deprecated
public void addIdentity(DiscoverInfo.Identity identity)

Deprecated.

use DiscoverInfoBuilder.addIdentity(DiscoverInfo.Identity) instead.

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

Parameters:

identity - the discovered entity's identity

addIdentities

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

Deprecated.

use DiscoverInfoBuilder.addIdentities(Collection) instead.

Adds identities to the DiscoverInfo stanza.

Parameters:

identitiesToAdd - TODO javadoc me please

getIdentities

public List<DiscoverInfo.Identity> getIdentities()

Description copied from interface: DiscoverInfoView

Returns the discovered identities of an XMPP entity.

Specified by:

getIdentities in interface DiscoverInfoView

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

Description copied from interface: DiscoverInfoView

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.

Specified by:

getNode in interface DiscoverInfoView

Returns:

the node attribute that supplements the 'jid' attribute

setNode

@Deprecated
public void setNode(String node)

Deprecated.

use DiscoverInfoBuilder.setNode(String) instead.

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

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

Parameters:

feature - the feature to check

Returns:

true if the requests 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 you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements 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 ExtensionElements), 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

asBuilder

public DiscoverInfoBuilder asBuilder(String stanzaId)

clone

@Deprecated
public DiscoverInfo clone()

Deprecated.

use asBuilder(String) instead.

Deprecated, do not use.

Overrides:

clone in class Object

builder

public static DiscoverInfoBuilder builder(XMPPConnection connection)

builder

public static DiscoverInfoBuilder builder(IqData iqData)

builder

public static DiscoverInfoBuilder builder(String stanzaId)