org.jdom.adapters

Interface DOMAdapter

Known Implementing Classes:
AbstractDOMAdapter, CrimsonDOMAdapter, JAXPDOMAdapter, OracleV1DOMAdapter, OracleV2DOMAdapter, XercesDOMAdapter, XML4JDOMAdapter

public interface DOMAdapter

Defines a standard set of adapter methods for interfacing with a DOM parser and obtaining a DOM org.w3c.dom.Document object. Implementing classes map these calls to DOM parser-specific calls, allowing any third-party parser to be used with JDOM.
Version:
$Revision: 1.21 $, $Date: 2004/02/06 09:28:31 $
Authors:
Brett McLaughlin
Jason Hunter

Method Summary

Document
createDocument()
This creates an empty Document object based on a specific parser implementation.
Document
createDocument(DocType doctype)
This creates an empty Document object based on a specific parser implementation with the given DOCTYPE.
Document
getDocument(File filename, boolean validate)
This creates a new Document from a given filename by letting a DOM parser handle parsing from the file.
Document
getDocument(InputStream in, boolean validate)
This creates a new Document from an existing InputStream by letting a DOM parser handle parsing using the supplied stream.

Method Details

createDocument

public Document createDocument()
            throws JDOMException
This creates an empty Document object based on a specific parser implementation.
Returns:
Document - created DOM Document.
Throws:
JDOMException - when errors occur.

createDocument

public Document createDocument(DocType doctype)
            throws JDOMException
This creates an empty Document object based on a specific parser implementation with the given DOCTYPE.
Parameters:
doctype - Initial DocType of the document.
Returns:
Document - created DOM Document.
Throws:
JDOMException - when errors occur.

getDocument

public Document getDocument(File filename,
                            boolean validate)
            throws IOException,
                   JDOMException
This creates a new Document from a given filename by letting a DOM parser handle parsing from the file.
Parameters:
filename - file to parse.
validate - boolean to indicate if validation should occur.
Returns:
Document - instance ready for use.
Throws:
JDOMException - when errors occur in parsing.

getDocument

public Document getDocument(InputStream in,
                            boolean validate)
            throws IOException,
                   JDOMException
This creates a new Document from an existing InputStream by letting a DOM parser handle parsing using the supplied stream.
Parameters:
in - InputStream to parse.
validate - boolean to indicate if validation should occur.
Returns:
Document - instance ready for use.
Throws:
JDOMException - when errors occur in parsing.

Copyright B) 2004 Jason Hunter, Brett McLaughlin. All Rights Reserved.