javax.xml.parsers

Class 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

DocumentBuilder()

Method Summary

abstract 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 Document
newDocument()
Creates a new, empty DOM Document.
Document
parse(File f)
Parse the specified file and return a DOM Document.
Document
parse(InputStream is)
Parse the specified input stream and return a DOM Document.
Document
parse(InputStream is, String systemId)
Parse the specified input stream and return a DOM Document.
Document
parse(String uri)
Parse the content of the specified URI and return a DOM Document.
abstract Document
parse(InputSource source)
Parse the specified input source and return a DOM Document.
void
reset()
Reset this document builder to its original configuration.
abstract void
setEntityResolver(EntityResolver er)
Sets the SAX entity resolver callback used to resolve external entities in the XML document(s) to parse.
abstract void
setErrorHandler(ErrorHandler eh)
Sets the SAX error handler callback used to report parsing errors.

Constructor Details

DocumentBuilder

protected DocumentBuilder()

Method Details

getDOMImplementation

public abstract DOMImplementation getDOMImplementation()
Returns the DOM implementation.

getSchema

public javax.xml.validation.Schema getSchema()
Returns the schema in use by the XML processor.

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.

isXIncludeAware

public boolean isXIncludeAware()
Returns the XInclude processing mode in use by the parser.

newDocument

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

parse

public Document parse(File f)
            throws SAXException,
                   IOException
Parse the specified file and return a DOM Document.
Parameters:
f - the XML file

parse

public Document parse(InputStream is)
            throws SAXException,
                   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

parse

public Document parse(InputStream is,
                      String systemId)
            throws SAXException,
                   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

parse

public Document parse(String uri)
            throws SAXException,
                   IOException
Parse the content of the specified URI and return a DOM Document.
Parameters:
uri - an XML system ID

parse

public abstract Document parse(InputSource source)
            throws SAXException,
                   IOException
Parse the specified input source and return a DOM Document.
Parameters:

reset

public void reset()
Reset this document builder to its original configuration.
Since:
1.3

setEntityResolver

public abstract void setEntityResolver(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(ErrorHandler eh)
Sets the SAX error handler callback used to report parsing errors.
Parameters:
eh - the error handler