APIdia Launch Partner
Top Description Constructors Methods
javax.xml.parsers

public abstract Class DocumentBuilder

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderImpl
Imports
java.io.File, .IOException, .InputStream, javax.xml.validation.Schema, org.w3c.dom.Document, .DOMImplementation, org.xml.sax.EntityResolver, .ErrorHandler, .InputSource, .SAXException
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.

Author
Jeff Suttor
Since
1.4

Constructor Summary

AccessConstructor and Description
protected
DocumentBuilder()

Protected constructor

Method Summary

Modifier and TypeMethod and Description
public abstract DOMImplementation

Returns:

A new instance of a DOMImplementation.
getDOMImplementation()

Obtain an instance of a DOMImplementation object.

public Schema

Returns:

Schema being used or null if none in use
getSchema()

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

public abstract boolean

Returns:

true if this parser is configured to understand namespaces; false otherwise.
isNamespaceAware()

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

public abstract boolean

Returns:

true if this parser is configured to validate XML documents; false otherwise.
isValidating()

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

public boolean

Returns:

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

Get the XInclude processing mode for this parser.

public abstract Document

Returns:

A new instance of a DOM Document object.
newDocument()

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

public Document

Returns:

Document result of parsing the InputStream
parse(InputStream
InputStream containing the content to be parsed.
is)

Parse the content of the given InputStream as an XML document and return a new DOM Document object.

public Document

Returns:

A new DOM Document object.
parse(InputStream
InputStream containing the content to be parsed.
is, String
Provide a base for resolving relative URIs.
systemId)

Parse the content of the given InputStream as an XML document and return a new DOM Document object.

public Document

Returns:

A new DOM Document object.
parse(String
The location of the content to be parsed.
uri)

Parse the content of the given URI as an XML document and return a new DOM Document object.

public Document

Returns:

A new DOM Document object.
parse(File
The file containing the XML to parse.
f)

Parse the content of the given file as an XML document and return a new DOM Document object.

public abstract Document

Returns:

A new DOM Document object.
parse(InputSource
InputSource containing the content to be parsed.
is)

Parse the content of the given input source as an XML document and return a new DOM Document object.

public void
reset()

Reset this DocumentBuilder to its original configuration.

public abstract void
setEntityResolver(EntityResolver
The EntityResolver to be used to resolve entities present in the XML document to be parsed.
er)

Specify the EntityResolver to be used to resolve entities present in the XML document to be parsed.

public abstract void
setErrorHandler(ErrorHandler
The ErrorHandler to be used by the parser.
eh)

Specify the ErrorHandler to be used by the parser.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DocumentBuilderback to summary
protected DocumentBuilder()

Protected constructor

Method Detail

getDOMImplementationback to summary
public abstract DOMImplementation getDOMImplementation()

Obtain an instance of a DOMImplementation object.

Returns:DOMImplementation

A new instance of a DOMImplementation.

getSchemaback to summary
public Schema getSchema()

Get a reference to 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

Exceptions
UnsupportedOperationException:
When implementation does not override this method
Since
1.5
isNamespaceAwareback to summary
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.

isValidatingback to summary
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.

isXIncludeAwareback to summary
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.

Exceptions
UnsupportedOperationException:
When implementation does not override this method
Since
1.5
See Also
DocumentBuilderFactory#setXIncludeAware(boolean)
newDocumentback to summary
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.

parseback to summary
public Document parse(InputStream is) throws SAXException, IOException

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

Exceptions
SAXException:
If any parse errors occur.
IOException:
If any IO errors occur.
IllegalArgumentException:
When is is null
See Also
org.xml.sax.DocumentHandler
parseback to summary
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 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.

Exceptions
SAXException:
If any parse errors occur.
IOException:
If any IO errors occur.
IllegalArgumentException:
When is is null
See Also
org.xml.sax.DocumentHandler
parseback to summary
public Document parse(String uri) throws SAXException, IOException

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.

Parameters
uri:String

The location of the content to be parsed.

Returns:Document

A new DOM Document object.

Exceptions
SAXException:
If any parse errors occur.
IOException:
If any IO errors occur.
IllegalArgumentException:
When uri is null
See Also
org.xml.sax.DocumentHandler
parseback to summary
public Document parse(File f) throws SAXException, IOException

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.

Parameters
f:File

The file containing the XML to parse.

Returns:Document

A new DOM Document object.

Exceptions
SAXException:
If any parse errors occur.
IOException:
If any IO errors occur.
IllegalArgumentException:
When f is null
See Also
org.xml.sax.DocumentHandler
parseback to summary
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 Document object. An IllegalArgumentException is thrown if the InputSource is null.

Parameters
is:InputSource

InputSource containing the content to be parsed.

Returns:Document

A new DOM Document object.

Exceptions
SAXException:
If any parse errors occur.
IOException:
If any IO errors occur.
IllegalArgumentException:
When is is null
See Also
org.xml.sax.DocumentHandler
resetback to summary
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 DocumentBuilders thus saving resources associated with the creation of new DocumentBuilders.

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

Exceptions
UnsupportedOperationException:
When implementation does not override this method.
Since
1.5
setEntityResolverback to summary
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.

setErrorHandlerback to summary
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.