| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.dom4j.io.XPP3Reader
 XPP3Reader 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.
 
| Constructor Summary | |
| XPP3Reader() | |
| XPP3Reader(DocumentFactory factory) | |
| Method Summary | |
|  void | addHandler(String path,
           ElementHandler handler)Adds the ElementHandlerto 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() | 
|  DocumentFactory | getDocumentFactory()DOCUMENT ME! | 
|  org.xmlpull.v1.XmlPullParserFactory | getXPPFactory() | 
|  org.xmlpull.v1.XmlPullParser | getXPPParser() | 
| protected  Document | parseDocument() | 
|  Document | read(char[] text)Reads a Document from the given array of characters | 
|  Document | read(File file)Reads a Document from the given File | 
|  Document | read(InputStream in)Reads a Document from the given stream | 
|  Document | read(InputStream in,
     String systemID)Reads a Document from the given stream | 
|  Document | read(Reader reader)Reads a Document from the given Reader | 
|  Document | read(Reader reader,
     String systemID)Reads a Document from the given Reader | 
|  Document | read(String systemID)Reads a Document from the given URL or filename. | 
|  Document | read(URL url)Reads a Document from the given URL | 
|  void | removeHandler(String path)Removes the ElementHandlerfrom the event based processor,
 for the specified path. | 
|  void | setDefaultHandler(ElementHandler handler)When multiple ElementHandlerinstances have been
 registered, this will set a defaultElementHandlerto be
 called for any path which does NOT  have a handler registered. | 
| protected  void | setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler) | 
|  void | setDocumentFactory(DocumentFactory documentFactory)This sets the DocumentFactoryused 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 Detail | 
public XPP3Reader()
public XPP3Reader(DocumentFactory factory)
| Method Detail | 
public Document read(File file)
              throws DocumentException,
                     IOException,
                     org.xmlpull.v1.XmlPullParserException
 Reads a Document from the given File
 
file - is the File to read from.
DocumentException - if an error occurs during parsing.
IOException - if a URL could not be made for the given File
org.xmlpull.v1.XmlPullParserException - DOCUMENT ME!
public Document read(URL url)
              throws DocumentException,
                     IOException,
                     org.xmlpull.v1.XmlPullParserException
 Reads a Document from the given URL
 
url - URL to read from.
DocumentException - if an error occurs during parsing.
IOException - DOCUMENT ME!
org.xmlpull.v1.XmlPullParserException - DOCUMENT ME!
public Document read(String systemID)
              throws 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 URLor a Fileinstance instead of a String to denote the source of the document.
 
systemID - is a URL for a document or a file name.
DocumentException - if an error occurs during parsing.
IOException - if a URL could not be made for the given File
org.xmlpull.v1.XmlPullParserException - DOCUMENT ME!
public Document read(InputStream in)
              throws DocumentException,
                     IOException,
                     org.xmlpull.v1.XmlPullParserException
Reads a Document from the given stream
in - InputStream to read from.
DocumentException - if an error occurs during parsing.
IOException - DOCUMENT ME!
org.xmlpull.v1.XmlPullParserException - DOCUMENT ME!
public Document read(Reader reader)
              throws DocumentException,
                     IOException,
                     org.xmlpull.v1.XmlPullParserException
 Reads a Document from the given Reader
 
reader - is the reader for the input
DocumentException - if an error occurs during parsing.
IOException - DOCUMENT ME!
org.xmlpull.v1.XmlPullParserException - DOCUMENT ME!
public Document read(char[] text)
              throws DocumentException,
                     IOException,
                     org.xmlpull.v1.XmlPullParserException
Reads a Document from the given array of characters
text - is the text to parse
DocumentException - if an error occurs during parsing.
IOException - DOCUMENT ME!
org.xmlpull.v1.XmlPullParserException - DOCUMENT ME!
public Document read(InputStream in,
                     String systemID)
              throws DocumentException,
                     IOException,
                     org.xmlpull.v1.XmlPullParserException
Reads a Document from the given stream
in - InputStream to read from.systemID - is the URI for the input
DocumentException - if an error occurs during parsing.
IOException - DOCUMENT ME!
org.xmlpull.v1.XmlPullParserException - DOCUMENT ME!
public Document read(Reader reader,
                     String systemID)
              throws DocumentException,
                     IOException,
                     org.xmlpull.v1.XmlPullParserException
 Reads a Document from the given Reader
 
reader - is the reader for the inputsystemID - is the URI for the input
DocumentException - if an error occurs during parsing.
IOException - DOCUMENT ME!
org.xmlpull.v1.XmlPullParserException - DOCUMENT ME!
public org.xmlpull.v1.XmlPullParser getXPPParser()
                                          throws org.xmlpull.v1.XmlPullParserException
org.xmlpull.v1.XmlPullParserException
public org.xmlpull.v1.XmlPullParserFactory getXPPFactory()
                                                  throws org.xmlpull.v1.XmlPullParserException
org.xmlpull.v1.XmlPullParserExceptionpublic void setXPPFactory(org.xmlpull.v1.XmlPullParserFactory xPPfactory)
public DocumentFactory getDocumentFactory()
DocumentFactory used to create document
         objectspublic void setDocumentFactory(DocumentFactory documentFactory)
 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
 
documentFactory - DocumentFactory used to create DOM4J objects
public void addHandler(String path,
                       ElementHandler handler)
ElementHandler to be called when the specified
 path is encounted.
path - is the path to be handledhandler - is the ElementHandler to be called by the event
            based processor.public void removeHandler(String path)
ElementHandler from the event based processor,
 for the specified path.
path - is the path to remove the ElementHandler for.public void setDefaultHandler(ElementHandler handler)
ElementHandler instances have been
 registered, this will set a default ElementHandler to be
 called for any path which does NOT  have a handler registered.
handler - is the ElementHandler to be called by the event
            based processor.
protected Document parseDocument()
                          throws DocumentException,
                                 IOException,
                                 org.xmlpull.v1.XmlPullParserException
DocumentException
IOException
org.xmlpull.v1.XmlPullParserExceptionprotected org.dom4j.io.DispatchHandler getDispatchHandler()
protected void setDispatchHandler(org.dom4j.io.DispatchHandler dispatchHandler)
protected Reader createReader(InputStream in)
                       throws IOException
in - DOCUMENT ME!
IOException - DOCUMENT ME!| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||