Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Application Server XML Java API Reference 10g Release 2 (10.1.2) Part no. B12024-03 September 2004
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.xml.parsers
Class DocumentBuilder

    java.lang.Object
      |
      +--javax.xml.parsers.DocumentBuilder

Direct Known Subclasses:
  JXDocumentBuilder

public abstract class DocumentBuilder
extends java.lang.Object

Defines the API to obtain DOM Document instances from an XML document. Using this class, an application programmer can obtain a `org.w3c.dom.Document` from XML.

An instance of this class can be obtained from the `DocumentBuilderFactory.newDocumentBuilder` method. Once an instance of this class is obtained, XML can be parsed from a variety of input sources. These input sources are InputStreams, Files, URLs, and SAX InputSources.

Note that this class reuses several classes from the SAX API. This does not require that the implementor of the underlying DOM implmenetation use a SAX parser to parse XML document into a `Document`. It merely requires that the implementation communicate with the application using these existing APIs.

Since:
  JAXP 1.0

Constructor Summary
`protected` | `DocumentBuilder()`

Method Summary
`abstract DOMImplementation` | `getDOMImplementation()` Obtain an instance of a DOMImplementation object.
`abstract boolean` | `isNamespaceAware()` Indicates whether or not this parser is configured to understand namespaces.
`abstract boolean` | `isValidating()` Indicates whether or not this parser is configured to validate XML documents.
`abstract Document` | `newDocument()` Obtain a new instance of a DOM Document object to build a DOM tree with.
`Document` | `parse(java.io.File f)` Parse the content of the given file as an XML document and return a new DOM Document object.
`abstract Document` | `parse(InputSource is)` Parse the content of the given input source as an XML document and return a new DOM Document object.
`Document` | `parse(java.io.InputStream is)` Parse the content of the given InputStream as an XML document and return a new DOM Document object.
`Document` | `parse(java.io.InputStream is, java.lang.String systemId)` Parse the content of the given InputStream as an XML document and return a new DOM Document object.
`Document` | `parse(java.lang.String uri)` Parse the content of the given URI as an XML document and return a new DOM Document object.
`abstract void` | `setEntityResolver(EntityResolver er)` Specify the `EntityResolver` to be used to resolve entities present in the XML document to be parsed.
`abstract void` | `setErrorHandler(ErrorHandler eh)` Specify the `ErrorHandler` to be used to resolve entities present in the XML document to be parsed.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### DocumentBuilder

    protected DocumentBuilder()

Method Detail

### parse

    public Document parse(java.io.InputStream is)
                   throws SAXException,
                          java.io.IOException

  Parse the content of the given InputStream as an XML document and return a new DOM Document object.
  Parameters:
    `is` - InputStream containing the content to be parsed.
  Throws:
    `java.io.IOException` - If any IO errors occur.
    `SAXException` - If any parse errors occur.
    `java.lang.IllegalArgumentException` - If the InputStream is null
  See Also:
    `DocumentHandler`

### parse

    public Document parse(java.io.InputStream is,
                          java.lang.String systemId)
                   throws SAXException,
                          java.io.IOException

  Parse the content of the given InputStream as an XML document and return a new DOM Document object.
  Parameters:
    `is` - InputStream containing the content to be parsed.
    `systemId` - Provide a base for resolving relative URIs.
  Throws:
    `java.io.IOException` - If any IO errors occur.
    `SAXException` - If any parse errors occur.
    `java.lang.IllegalArgumentException` - If the InputStream is null
  See Also:
    `DocumentHandler`

### parse

    public Document parse(java.lang.String uri)
                   throws SAXException,
                          java.io.IOException

  Parse the content of the given URI as an XML document and return a new DOM Document object.
  Parameters:
    `uri` - The location of the content to be parsed.
  Throws:
    `java.io.IOException` - If any IO errors occur.
    `SAXException` - If any parse errors occur.
    `java.lang.IllegalArgumentException` - If the URI is null
  See Also:
    `DocumentHandler`

### parse

    public Document parse(java.io.File f)
                   throws SAXException,
                          java.io.IOException

  Parse the content of the given file as an XML document and return a new DOM Document object.
  Parameters:
    `f` - The file containing the XML to parse
  Throws:
    `java.io.IOException` - If any IO errors occur.
    `SAXException` - If any parse errors occur.
    `java.lang.IllegalArgumentException` - If the file is null
  See Also:
    `DocumentHandler`

### parse

    public abstract Document parse(InputSource is)
                            throws SAXException,
                                   java.io.IOException

  Parse the content of the given input source as an XML document and return a new DOM Document object.
  Parameters:
    `is` - InputSource containing the content to be parsed.
  Throws:
    `java.io.IOException` - If any IO errors occur.
    `SAXException` - If any parse errors occur.
    `java.lang.IllegalArgumentException` - If the InputSource is null
  See Also:
    `DocumentHandler`

### isNamespaceAware

    public abstract boolean isNamespaceAware()

  Indicates whether or not this parser is configured to understand namespaces.

### isValidating

    public abstract boolean isValidating()

  Indicates whether or not this parser is configured to validate XML documents.

### setEntityResolver

    public abstract void setEntityResolver(EntityResolver er)

  Specify the `EntityResolver` to be used to resolve entities present in the XML document to be parsed. Setting this to `null` will result in the underlying implementation using it's own default implementation and behavior.

### setErrorHandler

    public abstract void setErrorHandler(ErrorHandler eh)

  Specify the `ErrorHandler` to be used to resolve entities present in the XML document to be parsed. Setting this to `null` will result in the underlying implementation using it's own default implementation and behavior.

### newDocument

    public abstract Document newDocument()

  Obtain a new instance of a DOM Document object to build a DOM tree with.

### getDOMImplementation

    public abstract DOMImplementation getDOMImplementation()

  Obtain an instance of a DOMImplementation object.

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Application Server XML Java API Reference 10g Release 2 (10.1.2) Part no. B12024-03 September 2004
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001 Sun Microsystems, Inc. All rights reserved.