com.metamatrix.common.xml
Interface XMLReaderWriter

All Known Implementing Classes:

XMLReaderWriterImpl

public interface XMLReaderWriter

This interface is used to read and write JDOM compliant XML files.

Method Summary

org.jdom.Document	readDocument(java.io.InputStream stream) This method will write a JDOM Document to an OutputStream.
void	writeDocument(org.jdom.Document doc, java.io.OutputStream stream) This method will write a JDOM Document to an OutputStream.

Method Detail

writeDocument

void writeDocument(org.jdom.Document doc,
                   java.io.OutputStream stream)
                   throws java.io.IOException

This method will write a JDOM Document to an OutputStream.

Parameters:

doc - the JDOM document to be written to the OutputStream

stream - the output stream to be written to.

Throws:

java.io.IOException - if there is a problem writing to the OutputStream

readDocument

org.jdom.Document readDocument(java.io.InputStream stream)
                               throws org.jdom.JDOMException,
                                      java.io.IOException

This method will write a JDOM Document to an OutputStream.

Parameters:

stream - the input stream to read the XML document from.

Returns:

the JDOM document reference that represents the XML text in the InputStream.

Throws:

java.io.IOException - if there is a problem reading from the InputStream

org.jdom.JDOMException - if the InputStream does not represent a JDOM compliant XML document.