Class XmlObjectParser

  • All Implemented Interfaces:
    ObjectParser

    @Beta
    public class XmlObjectParser
    extends Object
    implements ObjectParser
    Beta
    XML HTTP parser into an data class of key/value pairs.

    Implementation is thread-safe.

    Sample usage:

      static void setParser(HttpRequest request, XmlNamespaceDictionary namespaceDictionary) {
        request.setParser(new XmlObjectParser(namespaceDictionary));
      }
     
    Since:
    1.10
    Author:
    Matthias Linder (mlinder)
    • Constructor Detail

      • XmlObjectParser

        public XmlObjectParser​(XmlNamespaceDictionary namespaceDictionary)
        Creates an XmlObjectParser using the specified non-null namespace dictionary.
        Parameters:
        namespaceDictionary - XML namespace dictionary
    • Method Detail

      • getNamespaceDictionary

        public final XmlNamespaceDictionary getNamespaceDictionary()
        Returns the XML namespace dictionary.
      • parseAndClose

        public <T> T parseAndClose​(InputStream in,
                                   Charset charset,
                                   Class<T> dataClass)
                            throws IOException
        Description copied from interface: ObjectParser
        Parses the given input stream into a new instance of the the given data class of key/value pairs and closes the input stream.
        Specified by:
        parseAndClose in interface ObjectParser
        Parameters:
        in - input stream which contains the data to parse
        charset - charset which should be used to decode the input stream or null if unknown
        dataClass - class into which the data is parsed
        Throws:
        IOException
      • parseAndClose

        public Object parseAndClose​(InputStream in,
                                    Charset charset,
                                    Type dataType)
                             throws IOException
        Description copied from interface: ObjectParser
        Parses the given input stream into a new instance of the the given data type of key/value pairs and closes the input stream.
        Specified by:
        parseAndClose in interface ObjectParser
        Parameters:
        in - input stream which contains the data to parse
        charset - charset which should be used to decode the input stream or null if unknown
        dataType - type into which the data is parsed
        Throws:
        IOException
      • parseAndClose

        public <T> T parseAndClose​(Reader reader,
                                   Class<T> dataClass)
                            throws IOException
        Description copied from interface: ObjectParser
        Parses the given reader into a new instance of the the given data class of key/value pairs and closes the reader.
        Specified by:
        parseAndClose in interface ObjectParser
        Parameters:
        reader - reader which contains the text data to parse
        dataClass - class into which the data is parsed
        Throws:
        IOException
      • parseAndClose

        public Object parseAndClose​(Reader reader,
                                    Type dataType)
                             throws IOException
        Description copied from interface: ObjectParser
        Parses the given reader into a new instance of the the given data type of key/value pairs and closes the reader.
        Specified by:
        parseAndClose in interface ObjectParser
        Parameters:
        reader - reader which contains the text data to parse
        dataType - type into which the data is parsed
        Throws:
        IOException