javax.xml.parsers
class DocumentBuilder

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

Most common way to construct:

DocumentBuilderFactory factory = …;

DocumentBuilder builder = factory.newDocumentBuilder();

Based on 395 examples

public abstract class DocumentBuilder
extends Object

Defines the API to obtain DOM Document instances from an XML document. Using this class, an application programmer can obtain a {@link Document} from XML.

An instance of this class can be obtained from the {@link 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.

DocumentBuilder

protected DocumentBuilder()

Protected constructor

getDOMImplementation

public abstract DOMImplementation getDOMImplementation()

Obtain an instance of a {@link DOMImplementation} object.

Returns:

A new instance of a DOMImplementation.

getSchema

public Schema getSchema()

Get a reference to the the {@link Schema} being used by the XML processor.

If no schema is being used, null is returned.

Returns:

{@link Schema} being used or null if none in use

isNamespaceAware

public abstract boolean isNamespaceAware()

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

Returns:

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:

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:

the return value of the {@link DocumentBuilderFactory#isXIncludeAware()} when this parser was created from factory.

newDocument

public abstract Document newDocument()

Obtain a new instance of a DOM {@link Document} object to build a DOM tree with.

Returns:

A new instance of a DOM Document object.

parse

public Document parse(File f)
               throws SAXException,
                      IOException

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

Parameters:

f - The file containing the XML to parse.

Returns:

A new DOM Document object.

Throws:

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

parse

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

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

Parameters:

is - InputSource containing the content to be parsed.

Returns:

A new DOM Document object.

Throws:

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

parse

public Document parse(InputStream is)
               throws SAXException,
                      IOException

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

Parameters:

is - InputStream containing the content to be parsed.

Returns:

Document result of parsing the InputStream

Throws:

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

parse

public Document parse(InputStream is,
                      String systemId)
               throws SAXException,
                      IOException

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

Parameters:

is - InputStream containing the content to be parsed.

systemId - Provide a base for resolving relative URIs.

Returns:

A new DOM Document object.

Throws:

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

parse

public Document parse(String uri)
               throws SAXException,
                      IOException

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

Parameters:

uri - The location of the content to be parsed.

Returns:

A new DOM Document object.

Throws:

SAXException - If any parse errors occur.

IOException - If any IO errors occur.

reset

public void reset()

Reset this DocumentBuilder to its original configuration.

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

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

setEntityResolver

public abstract void setEntityResolver(EntityResolver er)

Specify the {@link 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 - 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 {@link 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 - The ErrorHandler to be used by the parser.