Class JivePropertiesExtension

java.lang.Object
org.jivesoftware.smackx.jiveproperties.packet.JivePropertiesExtension
All Implemented Interfaces:
Element, ExtensionElement, NamedElement, XmlElement, XmlLangElement

public class JivePropertiesExtension extends Object implements ExtensionElement
Properties provide an easy mechanism for clients to share data. Each property has a String name, and a value that is a Java primitive (int, long, float, double, boolean) or any Serializable object (a Java object is Serializable when it implements the Serializable interface).
  • Field Details

  • Constructor Details

  • Method Details

    • getProperty

      public Object getProperty(String name)
      Returns the stanza property with the specified name or null if the property doesn't exist. Property values that were originally primitives will be returned as their object equivalent. For example, an int property will be returned as an Integer, a double as a Double, etc.
      Parameters:
      name - the name of the property.
      Returns:
      the property, or null if the property doesn't exist.
    • setProperty

      public void setProperty(String name, Object value)
      Sets a property with an Object as the value. The value must be Serializable or an IllegalArgumentException will be thrown.
      Parameters:
      name - the name of the property.
      value - the value of the property.
    • deleteProperty

      public void deleteProperty(String name)
      Deletes a property.
      Parameters:
      name - the name of the property to delete.
    • getPropertyNames

      Returns an unmodifiable collection of all the property names that are set.
      Returns:
      all property names.
    • getProperties

      Returns an unmodifiable map of all properties.
      Returns:
      all properties.
    • getElementName

      Description copied from interface: NamedElement
      Returns the root element name.
      Specified by:
      getElementName in interface NamedElement
      Returns:
      the element name.
    • getNamespace

      public String getNamespace()
      Description copied from interface: XmlElement
      Returns the root element XML namespace.
      Specified by:
      getNamespace in interface XmlElement
      Returns:
      the namespace.
    • toXML

      public CharSequence toXML(XmlEnvironment enclosingNamespace)
      Specified by:
      toXML in interface Element
    • from

      public static JivePropertiesExtension from(Message message)
      Return a Jive properties extensions of the given message.
      Parameters:
      message - the message to return the extension from.
      Returns:
      a Jive properties extension or null.
      Since:
      4.2