DocumentBuilder

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 Document from XML.

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

Protected Constructor Summary

DocumentBuilder()
Protected constructor

Public Method Summary

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 Method Summary

Protected Constructors

protected DocumentBuilder ()

Protected constructor

Public Methods

public abstract DOMImplementation getDOMImplementation ()

Obtain an instance of a DOMImplementation object.

Returns
  • A new instance of a DOMImplementation.

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

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.

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.

public boolean isXIncludeAware ()

Get the XInclude processing mode for this parser.

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