SAXBuilderEngine

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

所有已实现的接口:

SAXEngine
```
public class SAXBuilderEngine
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:
1. The JDOMFactory is thread-safe (the JDOM-supplied JDOMFactories are)
2. There is no XMLFilter given to the SAXBuilder, or, if there is, then it is thread-safe.
3. If you have a custom XMLReaderJDOMFactory that it supplies a new instance of an XMLReader on each call (the JDOM-supplied ones all do).
4. If you have a custom SAXHandlerFactory that it supplies a new instance of a SAXHanfler on each call (the JDOM-supplied one does)
作者:

Rolf Lear

另请参阅:

org.jdom2.input.sax

构造器概要

构造器
构造器和说明

SAXBuilderEngine(org.xml.sax.XMLReader reader, SAXHandler handler, boolean validating)
Creates a new SAXBuilderEngine.

构造器
构造器和说明
`SAXBuilderEngine(org.xml.sax.XMLReader reader, SAXHandler handler, boolean validating)` Creates a new SAXBuilderEngine.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SAXBuilderEngine
```
public SAXBuilderEngine(org.xml.sax.XMLReader reader,
                        SAXHandler handler,
                        boolean validating)
```
    Creates a new SAXBuilderEngine.
    
    参数:
    
    reader - The XMLReader this Engine parses with
    
    handler - The SAXHandler that processes the SAX Events.
    
    validating - True if this is a validating system.
- 方法详细资料
  - getJDOMFactory
```
public JDOMFactory getJDOMFactory()
```
    从接口复制的说明: SAXEngine
    
    Returns the current JDOMFactory in use.
    
    指定者:
    
    getJDOMFactory 在接口中 SAXEngine
    
    返回:
    
    the factory in use
  - isValidating
```
public boolean isValidating()
```
    从接口复制的说明: SAXEngine
    
    Returns whether validation is to be performed during the build.
    
    指定者:
    
    isValidating 在接口中 SAXEngine
    
    返回:
    
    whether validation is to be performed during the build
  - getErrorHandler
```
public org.xml.sax.ErrorHandler getErrorHandler()
```
    从接口复制的说明: SAXEngine
    
    Returns the ErrorHandler assigned, or null if none.
    
    指定者:
    
    getErrorHandler 在接口中 SAXEngine
    
    返回:
    
    the ErrorHandler assigned, or null if none
  - getEntityResolver
```
public org.xml.sax.EntityResolver getEntityResolver()
```
    从接口复制的说明: SAXEngine
    
    Returns the EntityResolver assigned, or null if none.
    
    指定者:
    
    getEntityResolver 在接口中 SAXEngine
    
    返回:
    
    the EntityResolver assigned
  - getDTDHandler
```
public org.xml.sax.DTDHandler getDTDHandler()
```
    从接口复制的说明: SAXEngine
    
    Returns the DTDHandler assigned, or null if none.
    
    指定者:
    
    getDTDHandler 在接口中 SAXEngine
    
    返回:
    
    the DTDHandler assigned
  - getIgnoringElementContentWhitespace
```
public boolean getIgnoringElementContentWhitespace()
```
    从接口复制的说明: SAXEngine
    
    Returns whether element content whitespace is to be ignored during the build.
    
    指定者:
    
    getIgnoringElementContentWhitespace 在接口中 SAXEngine
    
    返回:
    
    whether element content whitespace is to be ignored during the build
  - getIgnoringBoundaryWhitespace
```
public boolean getIgnoringBoundaryWhitespace()
```
    从接口复制的说明: SAXEngine
    
    Returns whether or not the parser will elminate element content containing only whitespace.
    
    指定者:
    
    getIgnoringBoundaryWhitespace 在接口中 SAXEngine
    
    返回:
    
    boolean - whether only whitespace content will be ignored during build.
  - getExpandEntities
```
public boolean getExpandEntities()
```
    从接口复制的说明: SAXEngine
    
    Returns whether or not entities are being expanded into normal text content.
    
    指定者:
    
    getExpandEntities 在接口中 SAXEngine
    
    返回:
    
    whether entities are being expanded
  - build
```
public Document build(org.xml.sax.InputSource in)
               throws JDOMException,
                      java.io.IOException
```
    从接口复制的说明: SAXEngine
    
    This builds a document from the supplied input source.
    
    指定者:
    
    build 在接口中 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 parsed
  - build
```
public Document build(java.io.InputStream in)
               throws JDOMException,
                      java.io.IOException
```
    从接口复制的说明: SAXEngine
    
    This builds a document from the supplied input stream.
    
    指定者:
    
    build 在接口中 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.
  - build
```
public Document build(java.io.File file)
               throws JDOMException,
                      java.io.IOException
```
    从接口复制的说明: SAXEngine
    
    This builds a document from the supplied filename.
    
    指定者:
    
    build 在接口中 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 parsed
  - build
```
public Document build(java.net.URL url)
               throws JDOMException,
                      java.io.IOException
```
    从接口复制的说明: SAXEngine
    
    This builds a document from the supplied URL.
    
    指定者:
    
    build 在接口中 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.
  - build
```
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 在接口中 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 parsed
  - build
```
public 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 在接口中 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 parsed
  - build
```
public 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 在接口中 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 parsed
  - build
```
public Document build(java.lang.String systemId)
               throws JDOMException,
                      java.io.IOException
```
    从接口复制的说明: SAXEngine
    
    This builds a document from the supplied URI.
    
    指定者:
    
    build 在接口中 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

类 SAXBuilderEngine

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SAXBuilderEngine

方法详细资料

getJDOMFactory

isValidating

getErrorHandler

getEntityResolver

getDTDHandler

getIgnoringElementContentWhitespace

getIgnoringBoundaryWhitespace

getExpandEntities

build

build

build

build

build

build

build

build