Package org.jivesoftware.smackx.disco.packet

Class DiscoverItems.Item

java.lang.Object
org.jivesoftware.smackx.disco.packet.DiscoverItems.Item
Enclosing class:
DiscoverItems
public static class DiscoverItems.Item extends Object
An item is associated with an XMPP Entity, usually thought of a children of the parent entity and normally are addressable as a JID.

An item associated with an entity may not be addressable as a JID. In order to handle such items, Service Discovery uses an optional 'node' attribute that supplements the 'jid' attribute.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    REMOVE_ACTION
    Request to remove the item.
    static final String
    UPDATE_ACTION
    Request to create or update the item.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Item(org.jxmpp.jid.Jid entityID)
    Create a new Item associated with a given entity.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAction()
    Returns the action that specifies the action being taken for this item.
    org.jxmpp.jid.Jid
    getEntityID()
    Returns the entity's ID.
    String
    getName()
    Returns the entity's name.
    String
    getNode()
    Returns the node attribute that supplements the 'jid' attribute.
    void
    setAction(String action)
    Sets the action that specifies the action being taken for this item.
    void
    setName(String name)
    Sets the entity's name.
    void
    setNode(String node)
    Sets the node attribute that supplements the 'jid' attribute.
    String
    toString()
     
    org.jivesoftware.smack.util.XmlStringBuilder
    toXML()
     

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • Item

      public Item(org.jxmpp.jid.Jid entityID)
      Create a new Item associated with a given entity.
      Parameters:
      entityID - the id of the entity that contains the item

  • Method Details

    • getEntityID

      public org.jxmpp.jid.Jid getEntityID()
      Returns the entity's ID.
      Returns:
      the entity's ID.

    • getName

      public String getName()
      Returns the entity's name.
      Returns:
      the entity's name.

    • setName

      public void setName(String name)
      Sets the entity's name.
      Parameters:
      name - the entity's name.

    • 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

    • getAction

      public String getAction()
      Returns the action that specifies the action being taken for this item. Possible action values are: "update" and "remove". Update should either create a new entry if the node and jid combination does not already exist, or simply update an existing entry. If "remove" is used as the action, the item should be removed from persistent storage.
      Returns:
      the action being taken for this item

    • setAction

      public void setAction(String action)
      Sets the action that specifies the action being taken for this item. Possible action values are: "update" and "remove". Update should either create a new entry if the node and jid combination does not already exist, or simply update an existing entry. If "remove" is used as the action, the item should be removed from persistent storage.
      Parameters:
      action - the action being taken for this item

    • toXML

      public org.jivesoftware.smack.util.XmlStringBuilder toXML()

    • toString

      public String toString()
      Overrides:
      toString in class Object