Package org.jivesoftware.smack.roster.packet

Class RosterPacket.Item

  • All Implemented Interfaces:
    org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.ExtensionElement, org.jivesoftware.smack.packet.FullyQualifiedElement, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.XmlLangElement
    Enclosing class:
    RosterPacket
    public static final class RosterPacket.Item
extends java.lang.Object
implements org.jivesoftware.smack.packet.ExtensionElement
    A roster item, which consists of a JID, their name, the type of subscription, and the groups the roster item belongs to.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELEMENT
      The constant value ""item"".
      static java.lang.String GROUP  
      static javax.xml.namespace.QName QNAME  

    • Constructor Summary

      Constructors 
      Constructor Description
      Item​(org.jxmpp.jid.BareJid jid, java.lang.String name)
      Creates a new roster item.
      Item​(org.jxmpp.jid.BareJid jid, java.lang.String name, boolean subscriptionPending)
      Creates a new roster item.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addGroupName​(java.lang.String groupName)
      Adds a group name.
      boolean equals​(java.lang.Object obj)  
      java.lang.String getElementName()  
      java.util.Set<java.lang.String> getGroupNames()
      Returns an unmodifiable set of the group names that the roster item belongs to.
      RosterPacket.ItemType getItemType()
      Returns the roster item type.
      org.jxmpp.jid.BareJid getJid()
      Returns the JID of this item.
      java.lang.String getName()
      Returns the user's name.
      java.lang.String getNamespace()  
      java.lang.String getUser()
      Deprecated.
      use getJid() instead.
      int hashCode()  
      boolean isApproved()
      Returns the roster item pre-approval state.
      boolean isSubscriptionPending()  
      void removeGroupName​(java.lang.String groupName)
      Removes a group name.
      void setApproved​(boolean approved)
      Sets the roster item pre-approval state.
      void setItemType​(RosterPacket.ItemType itemType)
      Sets the roster item type.
      void setName​(java.lang.String name)
      Sets the user's name.
      void setSubscriptionPending​(boolean subscriptionPending)  
      org.jivesoftware.smack.util.XmlStringBuilder toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

        toXML, toXML

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

        getLanguage, getQName

    • Field Detail

      • ELEMENT

        public static final java.lang.String ELEMENT
        The constant value ""item"".
        See Also:
        Constant Field Values

      • QNAME

        public static final javax.xml.namespace.QName QNAME

    • Constructor Detail

      • Item

        public Item​(org.jxmpp.jid.BareJid jid,
            java.lang.String name)
        Creates a new roster item.
        Parameters:
        jid - TODO javadoc me please
        name - TODO javadoc me please

      • Item

        public Item​(org.jxmpp.jid.BareJid jid,
            java.lang.String name,
            boolean subscriptionPending)
        Creates a new roster item.
        Parameters:
        jid - the jid.
        name - the user's name.
        subscriptionPending - TODO javadoc me please

    • Method Detail

      • getElementName

        public java.lang.String getElementName()
        Specified by:
        getElementName in interface org.jivesoftware.smack.packet.NamedElement

      • getNamespace

        public java.lang.String getNamespace()
        Specified by:
        getNamespace in interface org.jivesoftware.smack.packet.FullyQualifiedElement

      • getUser

        @Deprecated
public java.lang.String getUser()
        Deprecated.
        use getJid() instead.
        Returns the user.
        Returns:
        the user.

      • getJid

        public org.jxmpp.jid.BareJid getJid()
        Returns the JID of this item.
        Returns:
        the JID.

      • getName

        public java.lang.String getName()
        Returns the user's name.
        Returns:
        the user's name.

      • setName

        public void setName​(java.lang.String name)
        Sets the user's name.
        Parameters:
        name - the user's name.

      • getItemType

        public RosterPacket.ItemType getItemType()
        Returns the roster item type.
        Returns:
        the roster item type.

      • setItemType

        public void setItemType​(RosterPacket.ItemType itemType)
        Sets the roster item type.
        Parameters:
        itemType - the roster item type.

      • setSubscriptionPending

        public void setSubscriptionPending​(boolean subscriptionPending)

      • isSubscriptionPending

        public boolean isSubscriptionPending()

      • isApproved

        public boolean isApproved()
        Returns the roster item pre-approval state.
        Returns:
        the pre-approval state.

      • setApproved

        public void setApproved​(boolean approved)
        Sets the roster item pre-approval state.
        Parameters:
        approved - the pre-approval flag.

      • getGroupNames

        public java.util.Set<java.lang.String> getGroupNames()
        Returns an unmodifiable set of the group names that the roster item belongs to.
        Returns:
        an unmodifiable set of the group names.

      • addGroupName

        public void addGroupName​(java.lang.String groupName)
        Adds a group name.
        Parameters:
        groupName - the group name.

      • removeGroupName

        public void removeGroupName​(java.lang.String groupName)
        Removes a group name.
        Parameters:
        groupName - the group name.

      • toXML

        public org.jivesoftware.smack.util.XmlStringBuilder toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
        Specified by:
        toXML in interface org.jivesoftware.smack.packet.Element

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object