|
JDOM 0.0.5-BETA |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jdom2.input.sax.SAXBuilderEngine
public class SAXBuilderEngine
Builds a JDOM document from files, streams, readers, URLs, or a SAX
InputSource
instance using a SAX parser. This Engine is
built by the SAXBuilder based on the state of the SAXBuilder when the engine
was produced. It is not possible to reconfigure the engine once built, but it
can be reused many times (though not concurrently). This makes it the fastest
way to process many multitudes of XML documents (if those documents are all
parsed the same way). If you want to process in multiple threads you can
safely have one SAXBuilderEngine in each thread on the condition that:
XMLReaderJDOMFactory
that it supplies a new
instance of an XMLReader on each call (the JDOM-supplied ones all do).
SAXHandlerFactory
that it supplies a new
instance of a SAXHanfler on each call (the JDOM-supplied one does)
org.jdom2.input.sax
Constructor Summary | |
---|---|
SAXBuilderEngine(org.xml.sax.XMLReader reader,
SAXHandler handler,
boolean validating)
Creates a new SAXBuilderEngine. |
Method Summary | |
---|---|
Document |
build(java.io.File file)
This builds a document from the supplied filename. |
Document |
build(org.xml.sax.InputSource in)
This builds a document from the supplied input source. |
Document |
build(java.io.InputStream in)
This builds a document from the supplied input stream. |
Document |
build(java.io.InputStream in,
java.lang.String systemId)
This builds a document from the supplied input stream. |
Document |
build(java.io.Reader characterStream)
This builds a document from the supplied Reader. |
Document |
build(java.io.Reader characterStream,
java.lang.String systemId)
This builds a document from the supplied Reader. |
Document |
build(java.lang.String systemId)
This builds a document from the supplied URI. |
Document |
build(java.net.URL url)
This builds a document from the supplied URL. |
org.xml.sax.DTDHandler |
getDTDHandler()
Returns the DTDHandler assigned, or null if none. |
org.xml.sax.EntityResolver |
getEntityResolver()
Returns the EntityResolver assigned, or null if none. |
org.xml.sax.ErrorHandler |
getErrorHandler()
Returns the ErrorHandler assigned, or null if none. |
JDOMFactory |
getJDOMFactory()
Returns the current JDOMFactory in use. |
boolean |
isExpandEntities()
Returns whether or not entities are being expanded into normal text content. |
boolean |
isIgnoringBoundaryWhitespace()
Returns whether or not the parser will elminate element content containing only whitespace. |
boolean |
isIgnoringElementContentWhitespace()
Returns whether element content whitespace is to be ignored during the build. |
boolean |
isValidating()
Returns whether validation is to be performed during the build. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SAXBuilderEngine(org.xml.sax.XMLReader reader, SAXHandler handler, boolean validating)
reader
- The XMLReader this Engine parses withhandler
- The SAXHandler that processes the SAX Events.validating
- True if this is a validating system.Method Detail |
---|
public JDOMFactory getJDOMFactory()
SAXEngine
JDOMFactory
in use.
getJDOMFactory
in interface SAXEngine
public boolean isValidating()
SAXEngine
isValidating
in interface SAXEngine
public org.xml.sax.ErrorHandler getErrorHandler()
SAXEngine
ErrorHandler
assigned, or null if none.
getErrorHandler
in interface SAXEngine
public org.xml.sax.EntityResolver getEntityResolver()
SAXEngine
EntityResolver
assigned, or null if none.
getEntityResolver
in interface SAXEngine
public org.xml.sax.DTDHandler getDTDHandler()
SAXEngine
DTDHandler
assigned, or null if none.
getDTDHandler
in interface SAXEngine
public boolean isIgnoringElementContentWhitespace()
SAXEngine
isIgnoringElementContentWhitespace
in interface SAXEngine
public boolean isIgnoringBoundaryWhitespace()
SAXEngine
isIgnoringBoundaryWhitespace
in interface SAXEngine
boolean
- whether only whitespace content will be
ignored during build.public boolean isExpandEntities()
SAXEngine
isExpandEntities
in interface SAXEngine
public Document build(org.xml.sax.InputSource in) throws JDOMException, java.io.IOException
SAXEngine
build
in interface SAXEngine
in
- InputSource
to read from
Document
resultant Document object
JDOMException
- when errors occur in parsing
java.io.IOException
- when an I/O error prevents a document from being fully parsedpublic Document build(java.io.InputStream in) throws JDOMException, java.io.IOException
SAXEngine
This builds a document from the supplied input stream.
build
in interface SAXEngine
in
- InputStream
to read from
Document
resultant Document object
JDOMException
- when errors occur in parsing
java.io.IOException
- when an I/O error prevents a document from being fully parsed.public Document build(java.io.File file) throws JDOMException, java.io.IOException
SAXEngine
This builds a document from the supplied filename.
build
in interface SAXEngine
file
- File
to read from
Document
resultant Document object
JDOMException
- when errors occur in parsing
java.io.IOException
- when an I/O error prevents a document from being fully parsedpublic Document build(java.net.URL url) throws JDOMException, java.io.IOException
SAXEngine
This builds a document from the supplied URL.
build
in interface SAXEngine
url
- URL
to read from.
Document
- resultant Document object.
JDOMException
- when errors occur in parsing
java.io.IOException
- when an I/O error prevents a document from being fully parsed.public Document build(java.io.InputStream in, java.lang.String systemId) throws JDOMException, java.io.IOException
SAXEngine
This builds a document from the supplied input stream.
build
in interface SAXEngine
in
- InputStream
to read from.systemId
- base for resolving relative URIs
Document
resultant Document object
JDOMException
- when errors occur in parsing
java.io.IOException
- when an I/O error prevents a document from being fully parsedpublic Document build(java.io.Reader characterStream) throws JDOMException, java.io.IOException
SAXEngine
This builds a document from the supplied Reader. It's the programmer's responsibility to make sure the reader matches the encoding of the file. It's often easier and safer to use an InputStream rather than a Reader, and to let the parser auto-detect the encoding from the XML declaration.
build
in interface SAXEngine
characterStream
- Reader
to read from
Document
resultant Document object
JDOMException
- when errors occur in parsing
java.io.IOException
- when an I/O error prevents a document from being fully parsedpublic Document build(java.io.Reader characterStream, java.lang.String systemId) throws JDOMException, java.io.IOException
SAXEngine
This builds a document from the supplied Reader. It's the programmer's responsibility to make sure the reader matches the encoding of the file. It's often easier and safer to use an InputStream rather than a Reader, and to let the parser auto-detect the encoding from the XML declaration.
build
in interface SAXEngine
characterStream
- Reader
to read from.systemId
- base for resolving relative URIs
Document
resultant Document object
JDOMException
- when errors occur in parsing
java.io.IOException
- when an I/O error prevents a document from being fully parsedpublic Document build(java.lang.String systemId) throws JDOMException, java.io.IOException
SAXEngine
This builds a document from the supplied URI.
build
in interface SAXEngine
systemId
- URI for the input
Document
resultant Document object
JDOMException
- when errors occur in parsing
java.io.IOException
- when an I/O error prevents a document from being fully parsed
|
JDOM 0.0.5-BETA |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |