org.jdom.adapters

Interface DOMAdapter

public interface DOMAdapter

DOMAdapter

This interface defines wrapper behavior for obtaining a DOM Document object from a DOM parser.

Version: $Revison$, $Date: 2002/01/08 09:17:10 $

Author: Brett McLaughlin Jason Hunter

Method Summary
DocumentcreateDocument()

This creates an empty Document object based on a specific parser implementation.

DocumentcreateDocument(DocType doctype)

This creates an empty Document object based on a specific parser implementation with the given DOCTYPE.

DocumentgetDocument(File filename, boolean validate)

This creates a new Document from a given filename by letting a DOM parser handle parsing from the file.

DocumentgetDocument(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 Detail

createDocument

public Document createDocument()

This creates an empty Document object based on a specific parser implementation.

Returns: Document - created DOM Document.

Throws: Exception when errors occur.

createDocument

public Document createDocument(DocType doctype)

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: Exception when errors occur.

getDocument

public 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.

Parameters: filename file to parse. validate boolean to indicate if validation should occur.

Returns: Document - instance ready for use.

Throws: Exception when errors occur in parsing.

getDocument

public 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.

Parameters: in InputStream to parse. validate boolean to indicate if validation should occur.

Returns: Document - instance ready for use.

Throws: Exception when errors occur in parsing.

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