File	Doc	Category	Size	Date	Package
DocumentBuilder.java	API Doc	Java SE 6 API	12069	Tue Jun 10 00:27:08 BST 2008	javax.xml.parsers

DocumentBuilder

• java.lang.Object

Fields Summary

Constructors Summary
protected DocumentBuilder() Protected constructor

Methods Summary
public abstract org.w3c.dom.DOMImplementation	getDOMImplementation() Obtain an instance of a {@link DOMImplementation} object. return A new instance of a DOMImplementation.
public javax.xml.validation.Schema	getSchema() Get a reference to the the {@link Schema} being used by the XML processor. If no schema is being used, null is returned. return {@link Schema} being used or null if none in use throws UnsupportedOperationException When implementation does not override this method since 1.5 throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" );
public abstract boolean	isNamespaceAware() Indicates whether or not this parser is configured to understand namespaces. return true if this parser is configured to understand namespaces; false otherwise.
public abstract boolean	isValidating() Indicates whether or not this parser is configured to validate XML documents. return true if this parser is configured to validate XML documents; false otherwise.
public boolean	isXIncludeAware() Get the XInclude processing mode for this parser. return the return value of the {@link DocumentBuilderFactory#isXIncludeAware()} when this parser was created from factory. throws UnsupportedOperationException When implementation does not override this method since 1.5 see DocumentBuilderFactory#setXIncludeAware(boolean) throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" );
public abstract org.w3c.dom.Document	newDocument() Obtain a new instance of a DOM {@link Document} object to build a DOM tree with. return A new instance of a DOM Document object.
public org.w3c.dom.Document	parse(java.io.InputStream is) Parse the content of the given InputStream as an XML document and return a new DOM {@link Document} object. An IllegalArgumentException is thrown if the InputStream is null. param is InputStream containing the content to be parsed. return Document result of parsing the InputStream throws IOException If any IO errors occur. throws SAXException If any parse errors occur. throws IllegalArgumentException When is is null see org.xml.sax.DocumentHandler if (is == null) { throw new IllegalArgumentException("InputStream cannot be null"); } InputSource in = new InputSource(is); return parse(in);
public org.w3c.dom.Document	parse(java.io.InputStream is, java.lang.String systemId) Parse the content of the given InputStream as an XML document and return a new DOM {@link Document} object. An IllegalArgumentException is thrown if the InputStream is null. param is InputStream containing the content to be parsed. param systemId Provide a base for resolving relative URIs. return A new DOM Document object. throws IOException If any IO errors occur. throws SAXException If any parse errors occur. throws IllegalArgumentException When is is null see org.xml.sax.DocumentHandler if (is == null) { throw new IllegalArgumentException("InputStream cannot be null"); } InputSource in = new InputSource(is); in.setSystemId(systemId); return parse(in);
public org.w3c.dom.Document	parse(java.lang.String uri) Parse the content of the given URI as an XML document and return a new DOM {@link Document} object. An IllegalArgumentException is thrown if the URI is null null. param uri The location of the content to be parsed. return A new DOM Document object. throws IOException If any IO errors occur. throws SAXException If any parse errors occur. throws IllegalArgumentException When uri is null see org.xml.sax.DocumentHandler if (uri == null) { throw new IllegalArgumentException("URI cannot be null"); } InputSource in = new InputSource(uri); return parse(in);
public org.w3c.dom.Document	parse(java.io.File f) Parse the content of the given file as an XML document and return a new DOM {@link Document} object. An IllegalArgumentException is thrown if the File is null null. param f The file containing the XML to parse. throws IOException If any IO errors occur. throws SAXException If any parse errors occur. throws IllegalArgumentException When f is null see org.xml.sax.DocumentHandler return A new DOM Document object. if (f == null) { throw new IllegalArgumentException("File cannot be null"); } //convert file to appropriate URI, f.toURI().toASCIIString() //converts the URI to string as per rule specified in //RFC 2396, InputSource in = new InputSource(f.toURI().toASCIIString()); return parse(in);
public abstract org.w3c.dom.Document	parse(org.xml.sax.InputSource is) Parse the content of the given input source as an XML document and return a new DOM {@link Document} object. An IllegalArgumentException is thrown if the InputSource is null null. param is InputSource containing the content to be parsed. return A new DOM Document object. throws IOException If any IO errors occur. throws SAXException If any parse errors occur. throws IllegalArgumentException When is is null see org.xml.sax.DocumentHandler
public void	reset() Reset this DocumentBuilder to its original configuration. DocumentBuilder is reset to the same state as when it was created with {@link DocumentBuilderFactory#newDocumentBuilder()}. reset() is designed to allow the reuse of existing DocumentBuilders thus saving resources associated with the creation of new DocumentBuilders. The reset DocumentBuilder is not guaranteed to have the same {@link EntityResolver} or {@link ErrorHandler} Objects, e.g. {@link Object#equals(Object obj)}. It is guaranteed to have a functionally equal EntityResolver and ErrorHandler. throws UnsupportedOperationException When implementation does not override this method. since 1.5 // implementors should override this method throw new UnsupportedOperationException( "This DocumentBuilder, \"" + this.getClass().getName() + "\", does not support the reset functionality." + " Specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\"" + " version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" );
public abstract void	setEntityResolver(org.xml.sax.EntityResolver er) Specify the {@link 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. param er The EntityResolver to be used to resolve entities present in the XML document to be parsed.
public abstract void	setErrorHandler(org.xml.sax.ErrorHandler eh) Specify the {@link ErrorHandler} to be used by the parser. Setting this to null will result in the underlying implementation using it's own default implementation and behavior. param eh The ErrorHandler to be used by the parser.