org.jdom.adapters
Interface DOMAdapter

All Known Implementing Classes:
AbstractDOMAdapter
public interface DOMAdapter

DOMAdapter

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

Author:
Brett McLaughlin, Jason Hunter
Version: 1.0
Method Summary
 DocumentcreateDocument()
           This creates an empty Document object based on a specific parser implementation.
 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()
                         throws java.io.IOException

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

Returns: Document - created DOM Document.
Throws:
IOException - when errors occur.

getDocument

public Document getDocument(File filename, boolean validate)
                      throws java.io.IOException

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:
IOException - when errors occur in parsing.

getDocument

public Document getDocument(InputStream in, boolean validate)
                      throws java.io.IOException

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:
IOException - when errors occur in parsing.