org.licas_xml.abs

Interface XMLReader

All Known Implementing Classes:

XMLReaderImpl

public interface XMLReader

This reads an XML element or document and converts to a String. This interface defines the methods required to read XML from a data stream.

Author:

Kieran Greer

Method Summary

Modifier and Type	Method and Description
java.io.Reader	openStream(java.lang.String publicID, java.lang.String systemID) Open a stream from the reader.
void	xmlToFile(java.io.FileOutputStream outputStream, Document document) Convert an XML document into its String equivalent and write to the file.
java.lang.String	xmlToFormattedString(Element element) Convert an XML document into a formatted String equivalent.
java.lang.String	xmlToString(Document document) Convert an XML document into its String equivalent.
java.lang.String	xmlToString(Element element) Convert an XML element into its String equivalent.

Method Detail

openStream

java.io.Reader openStream(java.lang.String publicID,
                          java.lang.String systemID)
                   throws java.lang.Exception

Open a stream from the reader.

Parameters:

publicID - the public ID which can be null.

systemID - the system ID which cannot be null.

Returns:

a reader to read from.

Throws:

java.lang.Exception - any error.

xmlToString

java.lang.String xmlToString(Document document)
                      throws java.lang.Exception

Convert an XML document into its String equivalent.

Parameters:

document - the document.

Returns:

the contents in String format.

Throws:

java.lang.Exception - any error.

xmlToString

java.lang.String xmlToString(Element element)
                      throws java.lang.Exception

Convert an XML element into its String equivalent.

Parameters:

element - the element.

Returns:

the contents in String format.

Throws:

java.lang.Exception - any error.

xmlToFormattedString

java.lang.String xmlToFormattedString(Element element)
                               throws java.lang.Exception

Convert an XML document into a formatted String equivalent.

Parameters:

element - the root element.

Returns:

the contents in String format.

Throws:

java.lang.Exception - any error.

xmlToFile

void xmlToFile(java.io.FileOutputStream outputStream,
               Document document)
        throws java.lang.Exception

Convert an XML document into its String equivalent and write to the file.

Parameters:

document - the document.

Throws:

java.lang.Exception - any error.