javax.xml.parsers
Class DocumentBuilder
java.lang.Object
javax.xml.parsers.DocumentBuilder
public abstract class DocumentBuilder
extends java.lang.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
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.
An implementation of
DocumentBuilder
is
NOT
guaranteed to behave as per the specification if it is used concurrently by
two or more threads. It is recommended to have one instance of the
DocumentBuilder
per thread or it is upto the application to
make sure about the use of
DocumentBuilder
from more than one
thread.
Version:
- JAXP 1.0
getDOMImplementation
public DOMImplementation getDOMImplementation()
- A new instance of a
DOMImplementation
.
isNamespaceAware
public boolean isNamespaceAware()
Indicates whether or not this parser is configured to
understand namespaces.
- true if this parser is configured to understand
namespaces; false otherwise.
isValidating
public boolean isValidating()
Indicates whether or not this parser is configured to
validate XML documents.
- true if this parser is configured to validate
XML documents; false otherwise.
newDocument
public Document newDocument()
Obtain a new instance of a DOM
Document
object
to build a DOM tree with. An alternative way to create a DOM
Document object is to use the
getDOMImplementation
method to get a DOM Level 2 DOMImplementation object and then use
DOM Level 2 methods on that object to create a DOM Document object.
- A new instance of a DOM Document object.
parse
public Document parse(File f)
throws SAXException,
IOException
Parse the content of the given file as an XML document
and return a new DOM
Document
object.
f
- The file containing the XML to parse.
- A new DOM Document object.
SAXException
- If any parse errors occur.
DocumentHandler
parse
public Document parse(InputStream is)
throws SAXException,
IOException
Parse the content of the given
InputStream
as an XML
document and return a new DOM
Document
object.
is
- InputStream containing the content to be parsed.
SAXException
- If any parse errors occur.
DocumentHandler
parse
public Document parse(InputStream is,
String systemId)
throws SAXException,
IOException
Parse the content of the given
InputStream
as an XML
document and return a new DOM
Document
object.
is
- InputStream containing the content to be parsed.systemId
- Provide a base for resolving relative URIs.
- A new DOM Document object.
SAXException
- If any parse errors occur.
DocumentHandler
parse
public Document parse(String uri)
throws SAXException,
IOException
Parse the content of the given URI as an XML document
and return a new DOM
Document
object.
uri
- The location of the content to be parsed.
- A new DOM Document object.
SAXException
- If any parse errors occur.
DocumentHandler
setEntityResolver
public void setEntityResolver(EntityResolver er)
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.
er
- The EntityResolver
to be used to resolve entities
present in the XML document to be parsed.
setErrorHandler
public void setErrorHandler(ErrorHandler eh)
Specify the
ErrorHandler
to be used to report
errors 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.
eh
- The ErrorHandler
to be used to report errors
present in the XML document to be parsed.
Copyright B) 2004 Apache XML Project. All Rights Reserved.