Package org.dom4j.io

Class XPPPacketReader

java.lang.Object
org.dom4j.io.XPPPacketReader
public class XPPPacketReader extends Object

XPPPacketReader is a Reader of DOM4J documents that uses the fast XML Pull Parser 3.x. It is very fast for use in SOAP style environments.

Version:
$Revision$
Author:
Pelle Braendgaard, James Strachan

  • Constructor Summary

    Constructors
    Constructor
    Description
    XPPPacketReader()
     
    XPPPacketReader(org.dom4j.DocumentFactory factory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addHandler(String path, org.dom4j.ElementHandler handler)
    Adds the ElementHandler to be called when the specified path is encounted.
    protected Reader
    createReader(InputStream in)
    Factory method to create a Reader from the given InputStream.
    protected org.dom4j.io.DispatchHandler
    getDispatchHandler()
     
    org.dom4j.DocumentFactory
    getDocumentFactory()
     
    org.xmlpull.v1.XmlPullParserFactory
    getXPPFactory()
     
    org.xmlpull.v1.XmlPullParser
    getXPPParser()
     
    org.dom4j.Document
    parseDocument()
     
    org.dom4j.Document
    read(char[] text)
    Reads a Document from the given array of characters
    org.dom4j.Document
    read(File file)
    Reads a Document from the given File
    org.dom4j.Document
    read(InputStream in)
    Reads a Document from the given stream
    org.dom4j.Document
    read(InputStream in, String systemID)
    Reads a Document from the given stream
    org.dom4j.Document
    read(Reader reader)
    Reads a Document from the given Reader
    org.dom4j.Document
    read(Reader reader, String systemID)
    Reads a Document from the given Reader
    org.dom4j.Document
    read(String systemID)
    Reads a Document from the given URL or filename.
    org.dom4j.Document
    read(URL url)
    Reads a Document from the given URL
    void
    removeHandler(String path)
    Removes the ElementHandler from the event based processor, for the specified path.
    void
    setDefaultHandler(org.dom4j.ElementHandler handler)
    When multiple ElementHandler instances have been registered, this will set a default ElementHandler to be called for any path which does NOT have a handler registered.
    protected void
    setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler)
     
    void
    setDocumentFactory(org.dom4j.DocumentFactory factory)
    This sets the DocumentFactory used to create new documents.
    void
    setXPPFactory(org.xmlpull.v1.XmlPullParserFactory xppFactory)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • XPPPacketReader

      public XPPPacketReader()

    • XPPPacketReader

      public XPPPacketReader(org.dom4j.DocumentFactory factory)

  • Method Details

    • read

      public org.dom4j.Document read(File file) throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException

      Reads a Document from the given File

      Parameters:
      file - is the File to read from.
      Returns:
      the newly created Document instance
      Throws:
      org.dom4j.DocumentException - if an error occurs during parsing.
      MalformedURLException - if a URL could not be made for the given File
      IOException
      org.xmlpull.v1.XmlPullParserException

    • read

      public org.dom4j.Document read(URL url) throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException

      Reads a Document from the given URL

      Parameters:
      url - URL to read from.
      Returns:
      the newly created Document instance
      Throws:
      org.dom4j.DocumentException - if an error occurs during parsing.
      IOException
      org.xmlpull.v1.XmlPullParserException

    • read

      public org.dom4j.Document read(String systemID) throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException

      Reads a Document from the given URL or filename.

      If the systemID contains a ':' character then it is assumed to be a URL otherwise its assumed to be a file name. If you want finer grained control over this mechansim then please explicitly pass in either a URL or a File instance instead of a String to denote the source of the document.

      Parameters:
      systemID - is a URL for a document or a file name.
      Returns:
      the newly created Document instance
      Throws:
      org.dom4j.DocumentException - if an error occurs during parsing.
      MalformedURLException - if a URL could not be made for the given File
      IOException
      org.xmlpull.v1.XmlPullParserException

    • read

      public org.dom4j.Document read(InputStream in) throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException

      Reads a Document from the given stream

      Parameters:
      in - InputStream to read from.
      Returns:
      the newly created Document instance
      Throws:
      org.dom4j.DocumentException - if an error occurs during parsing.
      IOException
      org.xmlpull.v1.XmlPullParserException

    • read

      public org.dom4j.Document read(Reader reader) throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException

      Reads a Document from the given Reader

      Parameters:
      reader - is the reader for the input
      Returns:
      the newly created Document instance
      Throws:
      org.dom4j.DocumentException - if an error occurs during parsing.
      IOException
      org.xmlpull.v1.XmlPullParserException

    • read

      public org.dom4j.Document read(char[] text) throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException

      Reads a Document from the given array of characters

      Parameters:
      text - is the text to parse
      Returns:
      the newly created Document instance
      Throws:
      org.dom4j.DocumentException - if an error occurs during parsing.
      IOException
      org.xmlpull.v1.XmlPullParserException

    • read

      public org.dom4j.Document read(InputStream in, String systemID) throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException

      Reads a Document from the given stream

      Parameters:
      in - InputStream to read from.
      systemID - is the URI for the input
      Returns:
      the newly created Document instance
      Throws:
      org.dom4j.DocumentException - if an error occurs during parsing.
      IOException
      org.xmlpull.v1.XmlPullParserException

    • read

      public org.dom4j.Document read(Reader reader, String systemID) throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException

      Reads a Document from the given Reader

      Parameters:
      reader - is the reader for the input
      systemID - is the URI for the input
      Returns:
      the newly created Document instance
      Throws:
      org.dom4j.DocumentException - if an error occurs during parsing.
      IOException
      org.xmlpull.v1.XmlPullParserException

    • getXPPParser

      public org.xmlpull.v1.XmlPullParser getXPPParser() throws org.xmlpull.v1.XmlPullParserException
      Throws:
      org.xmlpull.v1.XmlPullParserException

    • getXPPFactory

      public org.xmlpull.v1.XmlPullParserFactory getXPPFactory() throws org.xmlpull.v1.XmlPullParserException
      Throws:
      org.xmlpull.v1.XmlPullParserException

    • setXPPFactory

      public void setXPPFactory(org.xmlpull.v1.XmlPullParserFactory xppFactory)

    • getDocumentFactory

      public org.dom4j.DocumentFactory getDocumentFactory()
      Returns:
      the DocumentFactory used to create document objects

    • setDocumentFactory

      public void setDocumentFactory(org.dom4j.DocumentFactory factory)

      This sets the DocumentFactory used to create new documents. This method allows the building of custom DOM4J tree objects to be implemented easily using a custom derivation of DocumentFactory

      Parameters:
      factory - DocumentFactory used to create DOM4J objects

    • addHandler

      public void addHandler(String path, org.dom4j.ElementHandler handler)
      Adds the ElementHandler to be called when the specified path is encounted.
      Parameters:
      path - is the path to be handled
      handler - is the ElementHandler to be called by the event based processor.

    • removeHandler

      public void removeHandler(String path)
      Removes the ElementHandler from the event based processor, for the specified path.
      Parameters:
      path - is the path to remove the ElementHandler for.

    • setDefaultHandler

      public void setDefaultHandler(org.dom4j.ElementHandler handler)
      When multiple ElementHandler instances have been registered, this will set a default ElementHandler to be called for any path which does NOT have a handler registered.
      Parameters:
      handler - is the ElementHandler to be called by the event based processor.

    • parseDocument

      public org.dom4j.Document parseDocument() throws org.dom4j.DocumentException, IOException, org.xmlpull.v1.XmlPullParserException
      Throws:
      org.dom4j.DocumentException
      IOException
      org.xmlpull.v1.XmlPullParserException

    • getDispatchHandler

      protected org.dom4j.io.DispatchHandler getDispatchHandler()

    • setDispatchHandler

      protected void setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler)

    • createReader

      protected Reader createReader(InputStream in) throws IOException
      Factory method to create a Reader from the given InputStream.
      Throws:
      IOException