DocumentBuilder (Java SE 15 & JDK 15) (original) (raw)
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 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.
Since:
1.4
Constructor Summary
Constructors
| Modifier | Constructor | Description |
|---|---|---|
| protected | DocumentBuilder() | Protected constructor |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
| abstract DOMImplementation | getDOMImplementation() | Obtain an instance of a DOMImplementation object. |
| Schema | getSchema() | Get a reference to the the Schema 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 DOM Document 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 DOM Document object. |
| Document | parse(InputStream is) | Parse the content of the given InputStream as an XML document and return a new DOM Document object. |
| Document | parse(InputStream is,String systemId) | Parse the content of the given InputStream as an XML document and return a new DOM Document object. |
| Document | parse(String uri) | Parse the content of the given URI as an XML document and return a new DOM Document object. |
| abstract Document | parse(InputSource is) | Parse the content of the given input source as an XML document and return a new DOM Document object. |
| void | reset() | Reset this DocumentBuilder to its original configuration. |
| abstract void | setEntityResolver(EntityResolver er) | Specify the EntityResolver to be used to resolve entities present in the XML document to be parsed. |
| abstract void | setErrorHandler(ErrorHandler eh) | Specify the ErrorHandler to be used by the parser. |
Methods declared in class java.lang.Object
[clone](../../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long,int%29)
Constructor Details
DocumentBuilder
protected DocumentBuilder()
Protected constructorMethod Details
reset
public void reset()
Reset thisDocumentBuilderto its original configuration.
DocumentBuilderis reset to the same state as when it was created withDocumentBuilderFactory.newDocumentBuilder().reset()is designed to allow the reuse of existingDocumentBuilders thus saving resources associated with the creation of newDocumentBuilders.
The resetDocumentBuilderis not guaranteed to have the same EntityResolver or ErrorHandlerObjects, e.g. Object.equals(Object obj). It is guaranteed to have a functionally equalEntityResolverandErrorHandler.
Throws:
[UnsupportedOperationException](../../../../java.base/java/lang/UnsupportedOperationException.html "class in java.lang")- When implementation does not override this method.
Since:
1.5parse
Parse the content of the given
InputStreamas an XML document and return a new DOM Document object. AnIllegalArgumentExceptionis thrown if theInputStreamis null.
Parameters:
is- InputStream containing the content to be parsed.
Returns:
Documentresult of parsing theInputStream
Throws:
[IOException](../../../../java.base/java/io/IOException.html "class in java.io")- If any IO errors occur.
[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")- If any parse errors occur.
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")- Whenisisnull
See Also:
DocumentHandlerparse
Parse the content of the given
InputStreamas an XML document and return a new DOM Document object. AnIllegalArgumentExceptionis thrown if theInputStreamis 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](../../../../java.base/java/io/IOException.html "class in java.io")- If any IO errors occur.
[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")- If any parse errors occur.
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")- Whenisisnull
See Also:
DocumentHandlerparse
Parse the content of the given URI as an XML document and return a new DOM Document object. An
IllegalArgumentExceptionis thrown if the URI isnullnull.
Parameters:
uri- The location of the content to be parsed.
Returns:
A new DOM Document object.
Throws:
[IOException](../../../../java.base/java/io/IOException.html "class in java.io")- If any IO errors occur.
[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")- If any parse errors occur.
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")- Whenuriisnull
See Also:
DocumentHandlerparse
Parse the content of the given file as an XML document and return a new DOM Document object. An
IllegalArgumentExceptionis thrown if theFileisnullnull.
Parameters:
f- The file containing the XML to parse.
Returns:
A new DOM Document object.
Throws:
[IOException](../../../../java.base/java/io/IOException.html "class in java.io")- If any IO errors occur.
[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")- If any parse errors occur.
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")- Whenfisnull
See Also:
DocumentHandlerparse
Parse the content of the given input source as an XML document and return a new DOM Document object. An
IllegalArgumentExceptionis thrown if theInputSourceisnullnull.
Parameters:
is- InputSource containing the content to be parsed.
Returns:
A new DOM Document object.
Throws:
[IOException](../../../../java.base/java/io/IOException.html "class in java.io")- If any IO errors occur.
[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")- If any parse errors occur.
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")- Whenisisnull
See Also:
DocumentHandlerisNamespaceAware
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 the EntityResolver to be used to resolve entities present in the XML document to be parsed. Setting this tonullwill result in the underlying implementation using it's own default implementation and behavior.
Parameters:
er- TheEntityResolverto be used to resolve entities present in the XML document to be parsed.setErrorHandler
public abstract void setErrorHandler(ErrorHandler eh)
Specify the ErrorHandler to be used by the parser. Setting this tonullwill result in the underlying implementation using it's own default implementation and behavior.
Parameters:
eh- TheErrorHandlerto be used by the parser.newDocument
public abstract Document newDocument()
Obtain a new instance of a DOM Document object to build a DOM tree with.
Returns:
A new instance of a DOM Document object.getDOMImplementation
Returns:
A new instance of aDOMImplementation.getSchema
public Schema getSchema()
Get a reference to the the Schema being used by the XML processor.
If no schema is being used,nullis returned.
Returns:
Schema being used ornullif none in use
Throws:
[UnsupportedOperationException](../../../../java.base/java/lang/UnsupportedOperationException.html "class in java.lang")- When implementation does not override this method
Since:
1.5isXIncludeAware
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](../../../../java.base/java/lang/UnsupportedOperationException.html "class in java.lang")- When implementation does not override this method
Since:
1.5
See Also:
DocumentBuilderFactory.setXIncludeAware(boolean)