javax.xml.parsers

Class DocumentBuilder

java.lang.Object

javax.xml.parsers.DocumentBuilder

public abstract class DocumentBuilder
extends java.lang.Object

Convenience class for parsing an XML document into a W3C DOM object graph. Instances of this class are not guaranteed to be thread safe.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract org.w3c.dom.DOMImplementation	getDOMImplementation() Returns the DOM implementation.
javax.xml.validation.Schema	getSchema() Returns the schema in use by the XML processor.
abstract boolean	isNamespaceAware() Indicates whether this document builder is XML Namespace aware.
abstract boolean	isValidating() Indicates whether this document builder will validate its input.
boolean	isXIncludeAware() Returns the XInclude processing mode in use by the parser.
abstract org.w3c.dom.Document	newDocument() Creates a new, empty DOM Document.
org.w3c.dom.Document	parse(java.io.File f) Parse the specified file and return a DOM Document.
abstract org.w3c.dom.Document	parse(org.xml.sax.InputSource source) Parse the specified input source and return a DOM Document.
org.w3c.dom.Document	parse(java.io.InputStream is) Parse the specified input stream and return a DOM Document.
org.w3c.dom.Document	parse(java.io.InputStream is, java.lang.String systemId) Parse the specified input stream and return a DOM Document.
org.w3c.dom.Document	parse(java.lang.String uri) Parse the content of the specified URI and return a DOM Document.
void	reset() Reset this document builder to its original configuration.
abstract void	setEntityResolver(org.xml.sax.EntityResolver er) Sets the SAX entity resolver callback used to resolve external entities in the XML document(s) to parse.
abstract void	setErrorHandler(org.xml.sax.ErrorHandler eh) Sets the SAX error handler callback used to report parsing errors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentBuilder

protected DocumentBuilder()

Method Detail

parse

public org.w3c.dom.Document parse(java.io.InputStream is)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Parse the specified input stream and return a DOM Document. Prefer the version of this method that specifies a system ID, in order to resolve external references correctly.

Parameters:

is - an XML input stream

Throws:

java.lang.IllegalArgumentException - if the input stream is null

org.xml.sax.SAXException

java.io.IOException

parse

public org.w3c.dom.Document parse(java.io.InputStream is,
                         java.lang.String systemId)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Parse the specified input stream and return a DOM Document.

Parameters:

is - an XML input stream

systemId - the system ID of the XML document

Throws:

java.lang.IllegalArgumentException - if the input stream is null

org.xml.sax.SAXException

java.io.IOException

parse

public org.w3c.dom.Document parse(java.lang.String uri)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Parse the content of the specified URI and return a DOM Document.

Parameters:

uri - an XML system ID

Throws:

java.lang.IllegalArgumentException - if the URI is null

org.xml.sax.SAXException

java.io.IOException

parse

public org.w3c.dom.Document parse(java.io.File f)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Parse the specified file and return a DOM Document.

Parameters:

f - the XML file

Throws:

java.lang.IllegalArgumentException - if the file is null

org.xml.sax.SAXException

java.io.IOException

parse

public abstract org.w3c.dom.Document parse(org.xml.sax.InputSource source)
                                    throws org.xml.sax.SAXException,
                                           java.io.IOException

Parse the specified input source and return a DOM Document.

Parameters:

source - the input source

Throws:

java.lang.IllegalArgumentException - if the input source is null

org.xml.sax.SAXException

java.io.IOException

isNamespaceAware

public abstract boolean isNamespaceAware()

Indicates whether this document builder is XML Namespace aware.

isValidating

public abstract boolean isValidating()

Indicates whether this document builder will validate its input.

setEntityResolver

public abstract void setEntityResolver(org.xml.sax.EntityResolver er)

Sets the SAX entity resolver callback used to resolve external entities in the XML document(s) to parse.

Parameters:

er - an entity resolver

setErrorHandler

public abstract void setErrorHandler(org.xml.sax.ErrorHandler eh)

Sets the SAX error handler callback used to report parsing errors.

Parameters:

eh - the error handler

newDocument

public abstract org.w3c.dom.Document newDocument()

Creates a new, empty DOM Document. To create a document with a root element and optional doctype, use the DOMImplementation instead.

See Also:

DOMImplementation.createDocument(java.lang.String, java.lang.String, org.w3c.dom.DocumentType)

getDOMImplementation

public abstract org.w3c.dom.DOMImplementation getDOMImplementation()

Returns the DOM implementation.

reset

public void reset()

Reset this document builder to its original configuration.

Since:

1.3

getSchema

public javax.xml.validation.Schema getSchema()

Returns the schema in use by the XML processor.

isXIncludeAware

public boolean isXIncludeAware()

Returns the XInclude processing mode in use by the parser.