javax.xml.parsers
public abstract class DocumentBuilder extends Object
An instance of this class can be obtained from the {@link 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.
Version: $Revision: 226208 $, $Date: 2005-06-03 14:28:57 -0400 (Fri, 03 Jun 2005) $
Constructor Summary | |
---|---|
protected | DocumentBuilder() Protected constructor |
Method Summary | |
---|---|
abstract DOMImplementation | getDOMImplementation()
Obtain an instance of a {@link DOMImplementation} object.
|
Schema | getSchema() Get a reference to the the {@link Schema} being used by the XML processor. If no schema is being used, |
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 {@link Document} object
to build a DOM tree with.
|
Document | parse(InputStream is)
Parse the content of the given InputStream as an XML
document and return a new DOM {@link Document} object.
|
Document | parse(InputStream is, String systemId)
Parse the content of the given InputStream as an
XML document and return a new DOM {@link Document} object.
|
Document | parse(String uri)
Parse the content of the given URI as an XML document
and return a new DOM {@link Document} object.
|
Document | parse(File f)
Parse the content of the given file as an XML document
and return a new DOM {@link Document} object.
|
abstract Document | parse(InputSource is)
Parse the content of the given input source as an XML document
and return a new DOM {@link Document} object.
|
void | reset() Reset this
|
abstract void | setEntityResolver(EntityResolver er)
Specify the {@link EntityResolver} to be used to resolve
entities present in the XML document to be parsed. |
abstract void | setErrorHandler(ErrorHandler eh)
Specify the {@link ErrorHandler} to be used by the parser.
|
Returns: A new instance of a DOMImplementation
.
Get a reference to the the {@link Schema} being used by the XML processor.
If no schema is being used, null
is returned.
Returns: {@link 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.
Since: 1.5
Returns: true if this parser is configured to understand namespaces; false otherwise.
Returns: true if this parser is configured to validate XML documents; false otherwise.
Get the XInclude processing mode for this parser.
Returns: the return value of the {@link DocumentBuilderFactory#isXIncludeAware()} when this parser was created from factory.
Throws: UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.
Since: 1.5
See Also: DocumentBuilderFactory
Returns: A new instance of a DOM Document object.
InputStream
as an XML
document and return a new DOM {@link Document} object.
An IllegalArgumentException
is thrown if the
InputStream
is null.
Parameters: is InputStream containing the content to be parsed.
Returns: Document
result of parsing the
InputStream
Throws: IOException If any IO errors occur. SAXException If any parse errors occur.
See Also: DocumentHandler
InputStream
as an
XML document and return a new DOM {@link Document} object.
An IllegalArgumentException
is thrown if the
InputStream
is null.
Parameters: is InputStream containing the content to be parsed. systemId Provide a base for resolving relative URIs.
Returns: A new DOM Document object.
Throws: IOException If any IO errors occur. SAXException If any parse errors occur.
See Also: DocumentHandler
IllegalArgumentException
is thrown if the
URI is null
null.
Parameters: uri The location of the content to be parsed.
Returns: A new DOM Document object.
Throws: IOException If any IO errors occur. SAXException If any parse errors occur.
See Also: DocumentHandler
IllegalArgumentException
is thrown if the
File
is null
null.
Parameters: f The file containing the XML to parse.
Returns: A new DOM Document object.
Throws: IOException If any IO errors occur. SAXException If any parse errors occur.
See Also: DocumentHandler
IllegalArgumentException
is thrown if the
InputSource
is null
null.
Parameters: is InputSource containing the content to be parsed.
Returns: A new DOM Document object.
Throws: IOException If any IO errors occur. SAXException If any parse errors occur.
See Also: DocumentHandler
Reset this DocumentBuilder
to its original configuration.
DocumentBuilder
is reset to the same state as when it was created with
{@link DocumentBuilderFactory#newDocumentBuilder()}.
reset()
is designed to allow the reuse of existing DocumentBuilder
s
thus saving resources associated with the creation of new DocumentBuilder
s.
The reset DocumentBuilder
is not guaranteed to have the same {@link EntityResolver} or {@link ErrorHandler}
Object
s, e.g. {@link Object#equals(Object obj)}. It is guaranteed to have a functionally equal
EntityResolver
and ErrorHandler
.
Since: 1.5
null
will result in the underlying
implementation using it's own default implementation and
behavior.
Parameters: er The EntityResolver
to be used to resolve entities
present in the XML document to be parsed.
null
will result in the underlying
implementation using it's own default implementation and
behavior.
Parameters: eh The ErrorHandler
to be used by the parser.