1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
/* * The contents of this file are subject to the terms * of the Common Development and Distribution License * (the "License"). You may not use this file except * in compliance with the License. * * You can obtain a copy of the license at * https://jaxp.dev.java.net/CDDLv1.0.html. * See the License for the specific language governing * permissions and limitations under the License. * * When distributing Covered Code, include this CDDL * HEADER in each file and include the License file at * https://jaxp.dev.java.net/CDDLv1.0.html * If applicable add the following below this CDDL HEADER * with the fields enclosed by brackets "[]" replaced with * your own identifying information: Portions Copyright * [year] [name of copyright owner] */ /* * $Id: DocumentBuilder.java,v 1.5 2005/11/21 05:57:14 sunithareddy Exp $ * @(#)DocumentBuilder.java 1.29 06/07/13 * * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved. */ package javax.xml.parsers; import java.io.File; import java.io.IOException; import java.io.InputStream; import javax.xml.validation.Schema; import org.w3c.dom.Document; import org.w3c.dom.DOMImplementation; import org.xml.sax.EntityResolver; import org.xml.sax.ErrorHandler; import org.xml.sax.InputSource; import org.xml.sax.SAXException; /** * Defines the API to obtain DOM Document instances from an XML * document. Using this class, an application programmer can obtain a * {@link Document} from XML.<p> * * An instance of this class can be obtained from the * {@link 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.<p> * * 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 * <code>Document</code>. It merely requires that the implementation * communicate with the application using these existing APIs. * * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor</a> * @version $Revision: 1.5 $, $Date: 2005/11/21 05:57:14 $ */ public abstract class DocumentBuilder { /** Protected constructor */ protected DocumentBuilder () { } /** * <p>Reset this <code>DocumentBuilder</code> to its original configuration.</p> * * <p><code>DocumentBuilder</code> is reset to the same state as when it was created with * {@link DocumentBuilderFactory#newDocumentBuilder()}. * <code>reset()</code> is designed to allow the reuse of existing <code>DocumentBuilder</code>s * thus saving resources associated with the creation of new <code>DocumentBuilder</code>s.</p> * * <p>The reset <code>DocumentBuilder</code> is not guaranteed to have the same {@link EntityResolver} or {@link ErrorHandler} * <code>Object</code>s, e.g. {@link Object#equals(Object obj)}. It is guaranteed to have a functionally equal * <code>EntityResolver</code> and <code>ErrorHandler</code>.</p> * * @throws UnsupportedOperationException When implementation does not * override this method. * * @since 1.5 */ public void reset() { // 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() + "\"" ); } /** * Parse the content of the given <code>InputStream</code> as an XML * document and return a new DOM {@link Document} object. * An <code>IllegalArgumentException</code> is thrown if the * <code>InputStream</code> is null. * * @param is InputStream containing the content to be parsed. * * @return <code>Document</code> result of parsing the * <code>InputStream</code> * * @throws IOException If any IO errors occur. * @throws SAXException If any parse errors occur. * @throws IllegalArgumentException When <code>is</code> is <code>null</code> * * @see org.xml.sax.DocumentHandler */ public Document parse(InputStream is) throws SAXException, IOException { if (is == null) { throw new IllegalArgumentException("InputStream cannot be null"); } InputSource in = new InputSource(is); return parse(in); } /** * Parse the content of the given <code>InputStream</code> as an * XML document and return a new DOM {@link Document} object. * An <code>IllegalArgumentException</code> is thrown if the * <code>InputStream</code> 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 <code>is</code> is <code>null</code> * * @see org.xml.sax.DocumentHandler */ public Document parse(InputStream is, String systemId) throws SAXException, IOException { if (is == null) { throw new IllegalArgumentException("InputStream cannot be null"); } InputSource in = new InputSource(is); in.setSystemId(systemId); return parse(in); } /** * Parse the content of the given URI as an XML document * and return a new DOM {@link Document} object. * An <code>IllegalArgumentException</code> is thrown if the * URI is <code>null</code> 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 <code>uri</code> is <code>null</code> * * @see org.xml.sax.DocumentHandler */ public Document parse(String uri) throws SAXException, IOException { if (uri == null) { throw new IllegalArgumentException("URI cannot be null"); } InputSource in = new InputSource(uri); return parse(in); } /** * Parse the content of the given file as an XML document * and return a new DOM {@link Document} object. * An <code>IllegalArgumentException</code> is thrown if the * <code>File</code> is <code>null</code> 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 <code>f</code> is <code>null</code> * * @see org.xml.sax.DocumentHandler * @return A new DOM Document object. */ public Document parse(File f) throws SAXException, IOException { 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); } /** * Parse the content of the given input source as an XML document * and return a new DOM {@link Document} object. * An <code>IllegalArgumentException</code> is thrown if the * <code>InputSource</code> is <code>null</code> 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 <code>is</code> is <code>null</code> * * @see org.xml.sax.DocumentHandler */ public abstract Document parse(InputSource is) throws SAXException, IOException; /** * 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 isNamespaceAware(); /** * 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 abstract boolean isValidating(); /** * Specify the {@link EntityResolver} to be used to resolve * entities present in the XML document to be parsed. Setting * this to <code>null</code> will result in the underlying * implementation using it's own default implementation and * behavior. * * @param er The <code>EntityResolver</code> to be used to resolve entities * present in the XML document to be parsed. */ public abstract void setEntityResolver(EntityResolver er); /** * Specify the {@link ErrorHandler} to be used by the parser. * Setting this to <code>null</code> will result in the underlying * implementation using it's own default implementation and * behavior. * * @param eh The <code>ErrorHandler</code> to be used by the parser. */ public abstract void setErrorHandler(ErrorHandler eh); /** * 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 abstract Document newDocument(); /** * Obtain an instance of a {@link DOMImplementation} object. * * @return A new instance of a <code>DOMImplementation</code>. */ public abstract DOMImplementation getDOMImplementation(); /** <p>Get current state of canonicalization.</p> * * @return current state canonicalization control */ /* public boolean getCanonicalization() { return canonicalState; } */ /** <p>Get a reference to the the {@link Schema} being used by * the XML processor.</p> * * <p>If no schema is being used, <code>null</code> is returned.</p> * * @return {@link Schema} being used or <code>null</code> * if none in use * * @throws UnsupportedOperationException When implementation does not * override this method * * @since 1.5 */ public Schema getSchema() { throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" ); } /** * <p>Get the XInclude processing mode for this parser.</p> * * @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) */ public boolean isXIncludeAware() { throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" ); } }