Package org.jivesoftware.smack.roster.packet

Class RosterPacket

  • 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 final class RosterPacket
extends org.jivesoftware.smack.packet.IQ
    Represents XMPP roster packets.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RosterPacket.Item
      A roster item, which consists of a JID, their name, the type of subscription, and the groups the roster item belongs to.
      static class  RosterPacket.ItemType  

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addRosterItem​(RosterPacket.Item item)
      Adds a roster item to the packet.
      protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder​(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)  
      int getRosterItemCount()
      Returns the number of roster items in this roster packet.
      java.util.List<RosterPacket.Item> getRosterItems()
      Returns a copied list of the roster items in the packet.
      java.lang.String getVersion()  
      void setVersion​(java.lang.String version)  

      • 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

      • RosterPacket

        public RosterPacket()

    • Method Detail

      • addRosterItem

        public void addRosterItem​(RosterPacket.Item item)
        Adds a roster item to the packet.
        Parameters:
        item - a roster item.

      • getRosterItemCount

        public int getRosterItemCount()
        Returns the number of roster items in this roster packet.
        Returns:
        the number of roster items.

      • getRosterItems

        public java.util.List<RosterPacket.Item> getRosterItems()
        Returns a copied list of the roster items in the packet.
        Returns:
        a copied list of the roster items in the packet.

      • getIQChildElementBuilder

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

      • getVersion

        public java.lang.String getVersion()

      • setVersion

        public void setVersion​(java.lang.String version)