Movatterモバイル変換

Class DocumentBuilder

java.lang.Object  |  +--javax.xml.parsers.DocumentBuilder

public abstract classDocumentBuilder

extends java.lang.Object

Defines the API to obtain DOM Document instances from an XML document. Using this class, an application programmer can obtain aDocument from XML.

An instance of this class can be obtained from theDocumentBuilderFactory.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 aDocument. It merely requires that the implementation communicate with the application using these existing APIs.

An implementation ofDocumentBuilder isNOT 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 theDocumentBuilder per thread or it is upto the application to make sure about the use ofDocumentBuilder from more than one thread.

Since:

JAXP 1.0

DocumentBuilder

protectedDocumentBuilder()

parse

publicDocumentparse(java.io.InputStream is)               throwsSAXException,                      java.io.IOException

Parse the content of the givenInputStream as an XML document and return a new DOMDocument object.

Parameters:

is - InputStream containing the content to be parsed.

Throws:

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

SAXException - If any parse errors occur.

java.lang.IllegalArgumentException - If the InputStream is null

See Also:

DocumentHandler

parse

publicDocumentparse(java.io.InputStream is,                      java.lang.String systemId)               throwsSAXException,                      java.io.IOException

Parse the content of the givenInputStream as an XML document and return a new DOMDocument object.

Parameters:

is - InputStream containing the content to be parsed.

systemId - Provide a base for resolving relative URIs.

Returns:

A new DOM Document object.

Throws:

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

SAXException - If any parse errors occur.

java.lang.IllegalArgumentException - If the InputStream is null.

See Also:

DocumentHandler

parse

publicDocumentparse(java.lang.String uri)               throwsSAXException,                      java.io.IOException

Parse the content of the given URI as an XML document and return a new DOMDocument object.

Parameters:

uri - The location of the content to be parsed.

Returns:

A new DOM Document object.

Throws:

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

SAXException - If any parse errors occur.

java.lang.IllegalArgumentException - If the URI is null.

See Also:

DocumentHandler

parse

publicDocumentparse(java.io.File f)               throwsSAXException,                      java.io.IOException

Parse the content of the given file as an XML document and return a new DOMDocument object.

Parameters:

f - The file containing the XML to parse.

Returns:

A new DOM Document object.

Throws:

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

SAXException - If any parse errors occur.

java.lang.IllegalArgumentException - If the file is null.

See Also:

DocumentHandler

parse

public abstractDocumentparse(InputSource is)                        throwsSAXException,                               java.io.IOException

Parse the content of the given input source as an XML document and return a new DOMDocument object.

Parameters:

is - InputSource containing the content to be parsed.

Returns:

A new DOM Document object.

Throws:

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

SAXException - If any parse errors occur.

java.lang.IllegalArgumentException - If the InputSource is null.

See Also:

DocumentHandler

isNamespaceAware

public abstract booleanisNamespaceAware()

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 booleanisValidating()

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

public abstract voidsetEntityResolver(EntityResolver er)

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

public abstract voidsetErrorHandler(ErrorHandler eh)

Specify theErrorHandler to be used to report errors 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:

eh - TheErrorHandler to be used to report errors present in the XML document to be parsed.

newDocument

public abstractDocumentnewDocument()

Obtain a new instance of a DOMDocument object to build a DOM tree with. An alternative way to create a DOM Document object is to use thegetDOMImplementation 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.

Returns:

A new instance of a DOM Document object.

getDOMImplementation

public abstractDOMImplementationgetDOMImplementation()

Obtain an instance of aDOMImplementation object.

Returns:

A new instance of aDOMImplementation.