Added in API level 1

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(File f)` Parse the content of the given file 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.
`void`	`reset()` Reset this `DocumentBuilder`.
`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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Protected constructors

DocumentBuilder

Added in API level 1

protected DocumentBuilder ()

Protected constructor

Public methods

getDOMImplementation

Added in API level 1

public abstract DOMImplementation getDOMImplementation ()

Obtain an instance of a DOMImplementation object.

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

getSchema

Added in API level 8

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

Added in API level 1

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

Added in API level 1

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

Added in API level 1

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

Added in API level 1

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

Added in API level 1

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

Added in API level 1

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

Added in API level 1

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

parse

Added in API level 1

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

Added in API level 1

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

reset

Added in API level 1

public void reset ()

Reset this DocumentBuilder.

This method removes both the EntityResolver and ErrorHandler instances associated with this DocumentBuilder and sets all internal properties to false including those set by the DocumentBuilderFactory when this DocumentBuilder was created.

See also:

setEntityResolver

Added in API level 1

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

Added in API level 1

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.