SAXEngine (JDOM v2.0.6.1)

All Known Implementing Classes:

SAXBuilder, SAXBuilderEngine
```
public interface SAXEngine
```
SAXEngine provides an interface to interact with either the SAXBuilder or the SAXBuilderEngine. This makes it possible to do pooling of SAXEngines for parsing using instances of either SAXBuilder or SAXBuilderEngine.

Author:

Rolf Lear

See Also:

org.jdom2.input.sax

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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 eliminate 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.

- Method Detail
  - getJDOMFactory
```
JDOMFactory getJDOMFactory()
```
    Returns the current JDOMFactory in use.
    
    Returns:
    
    the factory in use
  - isValidating
```
boolean isValidating()
```
    Returns whether validation is to be performed during the build.
    
    Returns:
    
    whether validation is to be performed during the build
  - getErrorHandler
```
org.xml.sax.ErrorHandler getErrorHandler()
```
    Returns the ErrorHandler assigned, or null if none.
    
    Returns:
    
    the ErrorHandler assigned, or null if none
  - getEntityResolver
```
org.xml.sax.EntityResolver getEntityResolver()
```
    Returns the EntityResolver assigned, or null if none.
    
    Returns:
    
    the EntityResolver assigned
  - getDTDHandler
```
org.xml.sax.DTDHandler getDTDHandler()
```
    Returns the DTDHandler assigned, or null if none.
    
    Returns:
    
    the DTDHandler assigned
  - getIgnoringElementContentWhitespace
```
boolean getIgnoringElementContentWhitespace()
```
    Returns whether element content whitespace is to be ignored during the build.
    
    Returns:
    
    whether element content whitespace is to be ignored during the build
  - getIgnoringBoundaryWhitespace
```
boolean getIgnoringBoundaryWhitespace()
```
    Returns whether or not the parser will eliminate element content containing only whitespace.
    
    Returns:
    
    boolean - whether only whitespace content will be ignored during build.
  - getExpandEntities
```
boolean getExpandEntities()
```
    Returns whether or not entities are being expanded into normal text content.
    
    Returns:
    
    whether entities are being expanded
  - build
```
Document build(org.xml.sax.InputSource in)
        throws JDOMException,
               java.io.IOException
```
    This builds a document from the supplied input source.
    
    Parameters:
    
    in - InputSource to read from
    
    Returns:
    
    Document resultant Document object
    
    Throws:
    
    JDOMException - when errors occur in parsing
    
    java.io.IOException - when an I/O error prevents a document from being fully parsed
  - build
```
Document build(java.io.InputStream in)
        throws JDOMException,
               java.io.IOException
```
    This builds a document from the supplied input stream.
    
    Parameters:
    
    in - InputStream to read from
    
    Returns:
    
    Document resultant Document object
    
    Throws:
    
    JDOMException - when errors occur in parsing
    
    java.io.IOException - when an I/O error prevents a document from being fully parsed.
  - build
```
Document build(java.io.File file)
        throws JDOMException,
               java.io.IOException
```
    This builds a document from the supplied filename.
    
    Parameters:
    
    file - File to read from
    
    Returns:
    
    Document resultant Document object
    
    Throws:
    
    JDOMException - when errors occur in parsing
    
    java.io.IOException - when an I/O error prevents a document from being fully parsed
  - build
```
Document build(java.net.URL url)
        throws JDOMException,
               java.io.IOException
```
    This builds a document from the supplied URL.
    
    Parameters:
    
    url - URL to read from.
    
    Returns:
    
    Document - resultant Document object.
    
    Throws:
    
    JDOMException - when errors occur in parsing
    
    java.io.IOException - when an I/O error prevents a document from being fully parsed.
  - build
```
Document build(java.io.InputStream in,
               java.lang.String systemId)
        throws JDOMException,
               java.io.IOException
```
    This builds a document from the supplied input stream.
    
    Parameters:
    
    in - InputStream to read from.
    
    systemId - base for resolving relative URIs
    
    Returns:
    
    Document resultant Document object
    
    Throws:
    
    JDOMException - when errors occur in parsing
    
    java.io.IOException - when an I/O error prevents a document from being fully parsed
  - build
```
Document build(java.io.Reader characterStream)
        throws JDOMException,
               java.io.IOException
```
    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.
    
    Parameters:
    
    characterStream - Reader to read from
    
    Returns:
    
    Document resultant Document object
    
    Throws:
    
    JDOMException - when errors occur in parsing
    
    java.io.IOException - when an I/O error prevents a document from being fully parsed
  - build
```
Document build(java.io.Reader characterStream,
               java.lang.String systemId)
        throws JDOMException,
               java.io.IOException
```
    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.
    
    Parameters:
    
    characterStream - Reader to read from.
    
    systemId - base for resolving relative URIs
    
    Returns:
    
    Document resultant Document object
    
    Throws:
    
    JDOMException - when errors occur in parsing
    
    java.io.IOException - when an I/O error prevents a document from being fully parsed
  - build
```
Document build(java.lang.String systemId)
        throws JDOMException,
               java.io.IOException
```
    This builds a document from the supplied URI.
    
    Parameters:
    
    systemId - URI for the input
    
    Returns:
    
    Document resultant Document object
    
    Throws:
    
    JDOMException - when errors occur in parsing
    
    java.io.IOException - when an I/O error prevents a document from being fully parsed

Interface SAXEngine

Method Summary

Method Detail

getJDOMFactory

isValidating

getErrorHandler

getEntityResolver

getDTDHandler

getIgnoringElementContentWhitespace

getIgnoringBoundaryWhitespace

getExpandEntities

build

build

build

build

build

build

build

build