Home » xml-commons-external-1.4.01-src » javax » xml » parsers » [javadoc | source]
javax.xml.parsers
abstract public class: DocumentBuilder [javadoc | source]
java.lang.Object
   javax.xml.parsers.DocumentBuilder
Defines the API to obtain DOM Document instances from an XML document. Using this class, an application programmer can obtain a Document 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:
 protected DocumentBuilder() 
Method from javax.xml.parsers.DocumentBuilder Summary:
getDOMImplementation,   getSchema,   isNamespaceAware,   isValidating,   isXIncludeAware,   newDocument,   parse,   parse,   parse,   parse,   parse,   reset,   setEntityResolver,   setErrorHandler
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.parsers.DocumentBuilder Detail:
 abstract public DOMImplementation getDOMImplementation()
 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.

 abstract public boolean isNamespaceAware()
    Indicates whether or not this parser is configured to understand namespaces.
 abstract public boolean isValidating()
    Indicates whether or not this parser is configured to validate XML documents.
 public boolean isXIncludeAware() 

    Get the XInclude processing mode for this parser.

 abstract public Document newDocument()
    Obtain a new instance of a DOM Document object to build a DOM tree with.
 public Document parse(InputStream is) throws SAXException, IOException 
    Parse the content of the given InputStream as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the InputStream is null.
 public Document parse(String uri) throws SAXException, IOException 
    Parse the content of the given URI as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the URI is null null.
 public Document parse(File f) throws SAXException, IOException 
    Parse the content of the given file as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the File is null null.
 abstract public Document parse(InputSource is) throws SAXException, IOException
    Parse the content of the given input source as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the InputSource is null null.
 public Document parse(InputStream is,
    String systemId) throws SAXException, IOException 
    Parse the content of the given InputStream as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the InputStream is null.
 public  void reset() 

    Reset this DocumentBuilder to its original configuration.

    DocumentBuilder is reset to the same state as when it was created with 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 EntityResolver or ErrorHandler Objects, e.g. Object#equals(Object obj) . It is guaranteed to have a functionally equal EntityResolver and ErrorHandler.

 abstract public  void setEntityResolver(EntityResolver er)
    Specify the 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.
 abstract public  void setErrorHandler(ErrorHandler eh)
    Specify the 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.