Class DefaultPrivateData

  • All Implemented Interfaces:

    public class DefaultPrivateData
    extends Object
    implements PrivateData
    Default implementation of the PrivateData interface. Unless a PrivateDataProvider is registered with the PrivateDataManager class, instances of this class will be returned when getting private data.

    This class provides a very simple representation of an XML sub-document. Each element is a key in a Map with its CDATA being the value. For example, given the following XML sub-document:

     <foo xmlns="">
    In this case, getValue("color") would return "blue", and getValue("food") would return "pizza". This parsing mechanism mechanism is very simplistic and will not work as desired in all cases (for example, if some of the elements have attributes. In those cases, a custom PrivateDataProvider should be used.
    • Constructor Detail

      • DefaultPrivateData

        public DefaultPrivateData​(String elementName,
                                  String namespace)
        Creates a new generic private data object.
        elementName - the name of the element of the XML sub-document.
        namespace - the namespace of the element.
    • Method Detail

      • getElementName

        public String getElementName()
        Returns the XML element name of the private data sub-packet root element.
        Specified by:
        getElementName in interface PrivateData
        the XML element name of the stanza extension.
      • getNamespace

        public String getNamespace()
        Returns the XML namespace of the private data sub-packet root element.
        Specified by:
        getNamespace in interface PrivateData
        the XML namespace of the stanza extension.
      • toXML

        public String toXML()
        Description copied from interface: PrivateData
        Returns the XML reppresentation of the PrivateData.
        Specified by:
        toXML in interface PrivateData
        the private data as XML.
      • getNames

        public Set<StringgetNames()
        Returns a Set of the names that can be used to get values of the private data.
        a Set of the names.
      • getValue

        public String getValue​(String name)
        Returns a value given a name.
        name - the name.
        the value.
      • setValue

        public void setValue​(String name,
                             String value)
        Sets a value given the name.
        name - the name.
        value - the value.