org.apache.xerces.jaxp
Class DocumentBuilderImpl

java.lang.Object
  javax.xml.parsers.DocumentBuilder
      org.apache.xerces.jaxp.DocumentBuilderImpl

All Implemented Interfaces:

JAXPConstants

public class DocumentBuilderImpl
extends DocumentBuilder
implements JAXPConstants

Version:

$Id: DocumentBuilderImpl.java 520058 2007-03-19 19:33:53Z mrglavas $

Author:

Rajiv Mordani, Edwin Goei

Field Summary

Fields inherited from interface org.apache.xerces.jaxp.JAXPConstants

JAXP_SCHEMA_LANGUAGE, JAXP_SCHEMA_SOURCE, W3C_XML_SCHEMA

Method Summary

DOMImplementation	getDOMImplementation() Obtain an instance of a DOMImplementation object.
Schema	getSchema() Get a reference to the the Schema being used by the XML processor.
boolean	isNamespaceAware() Indicates whether or not this parser is configured to understand namespaces.
boolean	isValidating() Indicates whether or not this parser is configured to validate XML documents.
boolean	isXIncludeAware() Gets the XInclude processing mode for this parser
Document	newDocument() Non-preferred: use the getDOMImplementation() method instead of this one to get a DOM Level 2 DOMImplementation object and then use DOM Level 2 methods to create a DOM Document object.
Document	parse(InputSource is) Parse the content of the given input source as an XML document and return a new DOM Document object.
void	reset() Reset this DocumentBuilder to its original configuration.
void	setEntityResolver(EntityResolver er) Specify the EntityResolver to be used to resolve entities present in the XML document to be parsed.
void	setErrorHandler(ErrorHandler eh) Specify the ErrorHandler to be used by the parser.

Methods inherited from class javax.xml.parsers.DocumentBuilder

parse, parse, parse, parse

Methods inherited from class java.lang.Object

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

Method Detail

newDocument

public Document newDocument()

Non-preferred: use the getDOMImplementation() method instead of this one to get a DOM Level 2 DOMImplementation object and then use DOM Level 2 methods to create a DOM Document object.

Specified by:

newDocument in class DocumentBuilder

Returns:

A new instance of a DOM Document object.

getDOMImplementation

public DOMImplementation getDOMImplementation()

Description copied from class: DocumentBuilder

Obtain an instance of a DOMImplementation object.

Specified by:

getDOMImplementation in class DocumentBuilder

Returns:

A new instance of a DOMImplementation.

parse

public Document parse(InputSource is)
               throws SAXException,
                      java.io.IOException

Description copied from class: DocumentBuilder

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

Specified by:

parse in class DocumentBuilder

Parameters:

is - InputSource containing the content to be parsed.

Returns:

A new DOM Document object.

Throws:

SAXException - If any parse errors occur.

java.io.IOException - If any IO errors occur.

See Also:

DocumentHandler

isNamespaceAware

public boolean isNamespaceAware()

Description copied from class: DocumentBuilder

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

Specified by:

isNamespaceAware in class DocumentBuilder

Returns:

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

isValidating

public boolean isValidating()

Description copied from class: DocumentBuilder

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

Specified by:

isValidating in class DocumentBuilder

Returns:

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

isXIncludeAware

public boolean isXIncludeAware()

Gets the XInclude processing mode for this parser

Overrides:

isXIncludeAware in class DocumentBuilder

Returns:

the state of XInclude processing mode

See Also:

DocumentBuilderFactory.setXIncludeAware(boolean)

setEntityResolver

public void setEntityResolver(EntityResolver er)

Description copied from class: DocumentBuilder

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.

Specified by:

setEntityResolver in class DocumentBuilder

Parameters:

er - The EntityResolver to be used to resolve entities present in the XML document to be parsed.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Description copied from class: DocumentBuilder

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.

Specified by:

setErrorHandler in class DocumentBuilder

Parameters:

eh - The ErrorHandler to be used by the parser.

getSchema

public Schema getSchema()

Description copied from class: DocumentBuilder

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

If no schema is being used, null is returned.

Overrides:

getSchema in class DocumentBuilder

Returns:

Schema being used or null if none in use

reset

public void reset()

Description copied from class: DocumentBuilder

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.

Overrides:

reset in class DocumentBuilder