- java.lang.Object
-
- javax.xml.parsers.DocumentBuilder
-
public abstract class DocumentBuilder extends 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 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.
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
DocumentBuilder()
Protected constructor
-
Method Summary
Methods Modifier and Type Method and Description abstract DOMImplementation
getDOMImplementation()
Obtain an instance of aDOMImplementation
object.Schema
getSchema()
Get a reference to the theSchema
being used by the XML processor.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 DOMDocument
object to build a DOM tree with.Document
parse(File f)
Parse the content of the given file 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.Document
parse(InputStream is)
Parse the content of the givenInputStream
as an XML document and return a new DOMDocument
object.Document
parse(InputStream is, String systemId)
Parse the content of the givenInputStream
as an XML document and return a new DOMDocument
object.Document
parse(String uri)
Parse the content of the given URI as an XML document and return a new DOMDocument
object.void
reset()
Reset thisDocumentBuilder
to its original configuration.abstract void
setEntityResolver(EntityResolver er)
Specify theEntityResolver
to be used to resolve entities present in the XML document to be parsed.abstract void
setErrorHandler(ErrorHandler eh)
Specify theErrorHandler
to be used by the parser.
-
-
-
Method Detail
-
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
public Document parse(InputStream is) throws SAXException, IOException
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:
DocumentHandler
-
parse
public Document parse(InputStream is, String systemId) throws SAXException, IOException
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:
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 DOMDocument
object. AnIllegalArgumentException
is thrown if the URI isnull
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.IllegalArgumentException
- Whenuri
isnull
- See Also:
DocumentHandler
-
parse
public Document parse(File f) throws SAXException, IOException
Parse the content of the given file as an XML document and return a new DOMDocument
object. AnIllegalArgumentException
is thrown if theFile
isnull
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.IllegalArgumentException
- Whenf
isnull
- See Also:
DocumentHandler
-
parse
public abstract Document parse(InputSource is) throws SAXException, IOException
Parse the content of the given input source as an XML document and return a new DOMDocument
object. AnIllegalArgumentException
is thrown if theInputSource
isnull
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.IllegalArgumentException
- Whenis
isnull
- See Also:
DocumentHandler
-
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
public abstract void setEntityResolver(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 void setErrorHandler(ErrorHandler eh)
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
public abstract Document 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
public abstract DOMImplementation getDOMImplementation()
Obtain an instance of aDOMImplementation
object.- Returns:
- A new instance of a
DOMImplementation
.
-
getSchema
public Schema getSchema()
Get a reference to the 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:
DocumentBuilderFactory.setXIncludeAware(boolean)
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/xml/parsers/documentbuilder.html/.html/
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.