javax.xml.parsers

Class DocumentBuilder

Known Direct Subclasses:
GnomeDocumentBuilder

public abstract class DocumentBuilder
extends Object

Convenience class for parsing an XML document into a W3C DOM object graph. Instances of this class are not guaranteed to be thread safe.

Constructor Summary

DocumentBuilder()
The basic constructor.

Method Summary

abstract DOMImplementation
getDOMImplementation()
Returns the DOM implementation.
Schema
getSchema()
Returns the schema in use by the XML processor.
abstract boolean
isNamespaceAware()
Indicates whether this document builder is XML Namespace aware.
abstract boolean
isValidating()
Indicates whether this document builder will validate its input.
boolean
isXIncludeAware()
Returns the XInclude processing mode in use by the parser.
abstract Document
newDocument()
Creates a new, empty DOM Document.
Document
parse(File f)
Parse the specified file and return a DOM Document.
Document
parse(InputStream is)
Parse the specified input stream and return a DOM Document.
Document
parse(InputStream is, String systemId)
Parse the specified input stream and return a DOM Document.
Document
parse(String uri)
Parse the content of the specified URI and return a DOM Document.
abstract Document
parse(InputSource source)
Parse the specified input source and return a DOM Document.
void
reset()
Reset this document builder to its original configuration.
abstract void
setEntityResolver(EntityResolver er)
Sets the SAX entity resolver callback used to resolve external entities in the XML document(s) to parse.
abstract void
setErrorHandler(ErrorHandler eh)
Sets the SAX error handler callback used to report parsing errors.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentBuilder

protected DocumentBuilder()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

getDOMImplementation

public abstract DOMImplementation getDOMImplementation()
Returns the DOM implementation.

getSchema

public Schema getSchema()
Returns the schema in use by the XML processor.

isNamespaceAware

public abstract boolean isNamespaceAware()
Indicates whether this document builder is XML Namespace aware.

isValidating

public abstract boolean isValidating()
Indicates whether this document builder will validate its input.

isXIncludeAware

public boolean isXIncludeAware()
Returns the XInclude processing mode in use by the parser.

newDocument

public abstract Document newDocument()
Creates a new, empty DOM Document. To create a document with a root element and optional doctype, use the DOMImplementation instead.

parse

public Document parse(File f)
            throws SAXException,
                   IOException
Parse the specified file and return a DOM Document.
Parameters:
f - the XML file
Throws:
IllegalArgumentException - if the file is null

parse

public Document parse(InputStream is)
            throws SAXException,
                   IOException
Parse the specified input stream and return a DOM Document. Prefer the version of this method that specifies a system ID, in order to resolve external references correctly.
Parameters:
is - an XML input stream
Throws:
IllegalArgumentException - if the input stream is null

parse

public Document parse(InputStream is,
                      String systemId)
            throws SAXException,
                   IOException
Parse the specified input stream and return a DOM Document.
Parameters:
is - an XML input stream
systemId - the system ID of the XML document
Throws:
IllegalArgumentException - if the input stream is null

parse

public Document parse(String uri)
            throws SAXException,
                   IOException
Parse the content of the specified URI and return a DOM Document.
Parameters:
uri - an XML system ID
Throws:
IllegalArgumentException - if the URI is null

parse

public abstract Document parse(InputSource source)
            throws SAXException,
                   IOException
Parse the specified input source and return a DOM Document.
Parameters:
source - the input source
Throws:
IllegalArgumentException - if the input source is null

reset

public void reset()
Reset this document builder to its original configuration.
Since:
1.3

setEntityResolver

public abstract void setEntityResolver(EntityResolver er)
Sets the SAX entity resolver callback used to resolve external entities in the XML document(s) to parse.
Parameters:
er - an entity resolver

setErrorHandler

public abstract void setErrorHandler(ErrorHandler eh)
Sets the SAX error handler callback used to report parsing errors.
Parameters:
eh - the error handler

DocumentBuilder.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.