SAXBuilderEngine (JDOM v2.0.2)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

JDOM
2.0.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jdom2.input.sax
Class SAXBuilderEngine

java.lang.Object
  org.jdom2.input.sax.SAXBuilderEngine

All Implemented Interfaces:: SAXEngine

public class SAXBuilderEngine
extends java.lang.Object
implements SAXEngine
extends java.lang.Object
implements SAXEngine

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:

The JDOMFactory is thread-safe (the JDOM-supplied JDOMFactories are)
There is no XMLFilter given to the SAXBuilder, or, if there is, then it is thread-safe.
If you have a custom XMLReaderJDOMFactory that it supplies a new instance of an XMLReader on each call (the JDOM-supplied ones all do).
If you have a custom SAXHandlerFactory that it supplies a new instance of a SAXHanfler on each call (the JDOM-supplied one does)

Author:: Rolf Lear
See Also:: 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.
`boolean`	`getExpandEntities()` Returns whether or not entities are being expanded into normal text content.
`boolean`	`getIgnoringBoundaryWhitespace()` Returns whether or not the parser will elminate element content containing only whitespace.
`boolean`	`getIgnoringElementContentWhitespace()` Returns whether element content whitespace is to be ignored during the build.
`JDOMFactory`	`getJDOMFactory()` Returns the current `JDOMFactory` in use.
`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

SAXBuilderEngine

public SAXBuilderEngine(org.xml.sax.XMLReader reader,
                        SAXHandler handler,
                        boolean validating)

Creates a new SAXBuilderEngine.

Parameters:: reader - The XMLReader this Engine parses with; handler - The SAXHandler that processes the SAX Events.; validating - True if this is a validating system.

Method Detail