Class DiscoverItems

  • All Implemented Interfaces:
    org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.FullyQualifiedElement, org.jivesoftware.smack.packet.IqView, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.StanzaView, org.jivesoftware.smack.packet.TopLevelStreamElement, org.jivesoftware.smack.packet.XmlLangElement

    public class DiscoverItems
    extends org.jivesoftware.smack.packet.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 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

        org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder, org.jivesoftware.smack.packet.IQ.ResponseType, org.jivesoftware.smack.packet.IQ.Type
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELEMENT  
      static java.lang.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
      DiscoverItems()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addItem​(DiscoverItems.Item item)
      Adds a new item to the discovered information.
      void addItems​(java.util.Collection<DiscoverItems.Item> itemsToAdd)
      Adds a collection of items to the discovered information.
      protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder​(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder xml)  
      java.util.List<DiscoverItems.Item> getItems()
      Returns the discovered items of the queried XMPP entity.
      java.lang.String getNode()
      Returns the node attribute that supplements the 'jid' attribute.
      void setNode​(java.lang.String node)
      Sets the node attribute that supplements the 'jid' attribute.
      • 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

        clone, 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.StanzaView

        getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension
    • 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​(java.util.Collection<DiscoverItems.Item> itemsToAdd)
        Adds a collection of items to the discovered information. Does nothing if itemsToAdd is null
        Parameters:
        itemsToAdd - TODO javadoc me please
      • getItems

        public java.util.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 java.lang.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​(java.lang.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
      • getIQChildElementBuilder

        protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder​(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder xml)
        Specified by:
        getIQChildElementBuilder in class org.jivesoftware.smack.packet.IQ