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.
- Since:
- 1.4
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract DOMImplementation
Obtain an instance of aDOMImplementation
object.Get a reference to theSchema
being used by the XML processor.abstract boolean
Indicates whether or not this parser is configured to understand namespaces.abstract boolean
Indicates whether or not this parser is configured to validate XML documents.boolean
Get the XInclude processing mode for this parser.abstract Document
Obtain a new instance of a DOMDocument
object to build a DOM tree with.Parse the content of the given file as an XML document and return a new DOMDocument
object.parse
(InputStream is) Parse the content of the givenInputStream
as an XML document and return a new DOMDocument
object.parse
(InputStream is, String systemId) Parse the content of the givenInputStream
as an XML document and return a new DOMDocument
object.Parse the content of the given URI as an XML document and return a new DOMDocument
object.abstract Document
parse
(InputSource is) Parse the content of the given input source as an XML document and return a new DOMDocument
object.void
reset()
Reset thisDocumentBuilder
to its original configuration.abstract void
Specify theEntityResolver
to be used to resolve entities present in the XML document to be parsed.abstract void
Specify theErrorHandler
to be used by the parser.
-
Constructor Details
-
DocumentBuilder
protected DocumentBuilder()Protected constructor
-
-
Method Details
-
reset
public void reset()Reset this
DocumentBuilder
to its original configuration.DocumentBuilder
is reset to the same state as when it was created withDocumentBuilderFactory.newDocumentBuilder()
.reset()
is designed to allow the reuse of existingDocumentBuilder
s thus saving resources associated with the creation of newDocumentBuilder
s.The reset
DocumentBuilder
is not guaranteed to have the sameEntityResolver
orErrorHandler
Object
s, e.g.Object.equals(Object obj)
. It is guaranteed to have a functionally equalEntityResolver
andErrorHandler
.- Throws:
UnsupportedOperationException
- When implementation does not override this method.- Since:
- 1.5
-
parse
Parse the content of the givenInputStream
as an XML document and return a new DOMDocument
object. AnIllegalArgumentException
is thrown if theInputStream
is null.- Parameters:
is
- InputStream containing the content to be parsed.- Returns:
Document
result of parsing theInputStream
- Throws:
IOException
- If any IO errors occur.SAXException
- If any parse errors occur.IllegalArgumentException
- Whenis
isnull
- See Also:
-
parse
Parse the content of the givenInputStream
as an XML document and return a new DOMDocument
object. AnIllegalArgumentException
is thrown if theInputStream
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.IllegalArgumentException
- Whenis
isnull
- See Also:
-
parse
Parse the content of the given URI as an XML document and return a new DOMDocument
object. AnIllegalArgumentException
is thrown if the URI isnull
.- 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.IllegalArgumentException
- Whenuri
isnull
- See Also:
-
parse
Parse the content of the given file as an XML document and return a new DOMDocument
object. AnIllegalArgumentException
is thrown if theFile
isnull
.- 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.IllegalArgumentException
- Whenf
isnull
- See Also:
-
parse
Parse the content of the given input source as an XML document and return a new DOMDocument
object. AnIllegalArgumentException
is thrown if theInputSource
isnull
.- 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.IllegalArgumentException
- Whenis
isnull
- See Also:
-
isNamespaceAware
public abstract boolean isNamespaceAware()Indicates whether or not this parser is configured to understand namespaces.- Returns:
- true if this parser is configured to understand namespaces; false otherwise.
-
isValidating
public abstract boolean isValidating()Indicates whether or not this parser is configured to validate XML documents.- Returns:
- true if this parser is configured to validate XML documents; false otherwise.
-
setEntityResolver
Specify theEntityResolver
to be used to resolve entities present in the XML document to be parsed. Setting this tonull
will result in the underlying implementation using it's own default implementation and behavior.- Parameters:
er
- TheEntityResolver
to be used to resolve entities present in the XML document to be parsed.
-
setErrorHandler
Specify theErrorHandler
to be used by the parser. Setting this tonull
will result in the underlying implementation using it's own default implementation and behavior.- Parameters:
eh
- TheErrorHandler
to be used by the parser.
-
newDocument
Obtain a new instance of a DOMDocument
object to build a DOM tree with.- Returns:
- A new instance of a DOM Document object.
-
getDOMImplementation
Obtain an instance of aDOMImplementation
object.- Returns:
- A new instance of a
DOMImplementation
.
-
getSchema
Get a reference to the
Schema
being used by the XML processor.If no schema is being used,
null
is returned.- Returns:
Schema
being used ornull
if none in use- Throws:
UnsupportedOperationException
- When implementation does not override this method- Since:
- 1.5
-
isXIncludeAware
public boolean isXIncludeAware()Get the XInclude processing mode for this parser.
- Returns:
- the return value of
the
DocumentBuilderFactory.isXIncludeAware()
when this parser was created from factory. - Throws:
UnsupportedOperationException
- When implementation does not override this method- Since:
- 1.5
- See Also:
-