# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Protected Ctors | Methods | Inherited Methods

# DocumentBuilder

`public abstract class DocumentBuilder`
`extends Object` ``

java.lang.Object
↳ | javax.xml.parsers.DocumentBuilder

Defines the API to obtain DOM Document instances from an XML document. Using this class, an application programmer can obtain a `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 implementation 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.

## Summary

### Protected constructors
`DocumentBuilder()` Protected constructor

### Public methods
`abstract DOMImplementation` | `getDOMImplementation()` Obtain an instance of a `DOMImplementation` object.
`Schema` | `getSchema()` Get a reference to the the `Schema` being used by the XML processor.
`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.
`boolean` | `isXIncludeAware()` Get the XInclude processing mode for this parser.
`abstract Document` | `newDocument()` Obtain a new instance of a DOM `Document` object to build a DOM tree with.
`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(String uri)` Parse the content of the given URI as an XML document and return a new DOM `Document` object.
`Document` | `parse(InputStream is)` Parse the content of the given `InputStream` as an XML document and return a new DOM `Document` object.
`Document` | `parse(InputStream is, String systemId)` Parse the content of the given `InputStream` as an XML document and return a new DOM `Document` object.
`Document` | `parse(File f)` Parse the content of the given file as an XML document and return a new DOM `Document` object.
`void` | `reset()` Reset this `DocumentBuilder` to its original configuration.
`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 by the parser.

### Inherited methods
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

## Protected constructors

### DocumentBuilder

    protected DocumentBuilder ()

Protected constructor

## Public methods

### getDOMImplementation

    public abstract DOMImplementation getDOMImplementation ()

Obtain an instance of a `DOMImplementation` object.

Returns
`DOMImplementation` | A new instance of a `DOMImplementation`.

### getSchema

    public Schema getSchema ()

Get a reference to the the `Schema` being used by the XML processor.

If no schema is being used, `null` is returned.

Returns
`Schema` | `Schema` being used or `null` if none in use

Throws
`UnsupportedOperationException` | For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

### isNamespaceAware

    public abstract boolean isNamespaceAware ()

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

Returns
`boolean` | true if this parser is configured to understand namespaces; false otherwise.

### isValidating

    public abstract boolean isValidating ()

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

Returns
`boolean` | true if this parser is configured to validate XML documents; false otherwise.

### isXIncludeAware

    public boolean isXIncludeAware ()

Get the XInclude processing mode for this parser.

Returns
`boolean` | the return value of the `DocumentBuilderFactory#isXIncludeAware()` when this parser was created from factory.

Throws
`UnsupportedOperationException` | For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

See also:

- `DocumentBuilderFactory.setXIncludeAware(boolean)`

### newDocument

    public abstract Document newDocument ()

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

Returns
`Document` | A new instance of a DOM Document object.

### parse

    public abstract Document parse (InputSource is)

Parse the content of the given input source as an XML document and return a new DOM `Document` object. An `IllegalArgumentException` is thrown if the `InputSource` is `null` null.

Parameters
`is` | `InputSource`: InputSource containing the content to be parsed.

Returns
`Document` | A new DOM Document object.

Throws
`IOException` | If any IO errors occur.
`SAXException` | If any parse errors occur.

See also:

- `DocumentHandler`

### parse

    public Document parse (String uri)

Parse the content of the given URI as an XML document and return a new DOM `Document` object. An `IllegalArgumentException` is thrown if the URI is `null` null.

Parameters
`uri` | `String`: The location of the content to be parsed.

Returns
`Document` | A new DOM Document object.

Throws
`IOException` | If any IO errors occur.
`SAXException` | If any parse errors occur.

See also:

- `DocumentHandler`

### parse

    public Document parse (InputStream is)

Parse the content of the given `InputStream` as an XML document and return a new DOM `Document` object. An `IllegalArgumentException` is thrown if the `InputStream` is null.

Parameters
`is` | `InputStream`: InputStream containing the content to be parsed.

Returns
`Document` | `Document` result of parsing the `InputStream`

Throws
`IOException` | If any IO errors occur.
`SAXException` | If any parse errors occur.

See also:

- `DocumentHandler`

### parse

    public Document parse (InputStream is,
                    String systemId)

Parse the content of the given `InputStream` as an XML document and return a new DOM `Document` object. An `IllegalArgumentException` is thrown if the `InputStream` is null.

Parameters
`is` | `InputStream`: InputStream containing the content to be parsed.
`systemId` | `String`: Provide a base for resolving relative URIs.

Returns
`Document` | A new DOM Document object.

Throws
`IOException` | If any IO errors occur.
`SAXException` | If any parse errors occur.

See also:

- `DocumentHandler`

### parse

    public Document parse (File f)

Parse the content of the given file as an XML document and return a new DOM `Document` object. An `IllegalArgumentException` is thrown if the `File` is `null` null.

Parameters
`f` | `File`: The file containing the XML to parse.

Returns
`Document` | A new DOM Document object.

Throws
`IOException` | If any IO errors occur.
`SAXException` | If any parse errors occur.

See also:

- `DocumentHandler`

### reset

    public void reset ()

Reset this `DocumentBuilder` to its original configuration.

`DocumentBuilder` is reset to the same state as when it was created with `DocumentBuilderFactory#newDocumentBuilder()`. `reset()` is designed to allow the reuse of existing `DocumentBuilder`s thus saving resources associated with the creation of new `DocumentBuilder`s.

The reset `DocumentBuilder` is not guaranteed to have the same `EntityResolver` or `ErrorHandler` `Object`s, e.g. `Object#equals(Object obj)`. It is guaranteed to have a functionally equal `EntityResolver` and `ErrorHandler`.

### 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.

Parameters
`er` | `EntityResolver`: The `EntityResolver` to be used to resolve entities present in the XML document to be parsed.

### setErrorHandler

    public abstract void setErrorHandler (ErrorHandler eh)

Specify the `ErrorHandler` to be used by the parser. Setting this to `null` will result in the underlying implementation using it's own default implementation and behavior.

Parameters
`eh` | `ErrorHandler`: The `ErrorHandler` to be used by the parser.

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*