org.licas_xml.abs

Interface XMLWriter

All Known Implementing Classes:

XMLWriterImpl

public interface XMLWriter

This reads a String and converts inot XML elements. This interface defines the methods required to write XML to a data stream.

Author:

Kieran Greer

Method Summary

Modifier and Type	Method and Description
Element	elementFromStream(java.io.FileInputStream inputStream) Create an element representing the data in the input stream.
Element	stringToElement(java.lang.String elemStr) Convert the string representation back to an element.
void	write(Element xml) Writes an XML element.
void	write(Element xml, boolean prettyPrint) Writes an XML element.
void	write(Element xml, boolean prettyPrint, int indent) Writes an XML element.

Method Detail

stringToElement

Element stringToElement(java.lang.String elemStr)
                 throws java.lang.Exception

Convert the string representation back to an element.

Parameters:

elemStr - the element as a string.

Returns:

the re-constructed element.

Throws:

java.lang.Exception - any error.

elementFromStream

Element elementFromStream(java.io.FileInputStream inputStream)
                   throws java.lang.Exception

Create an element representing the data in the input stream.

Parameters:

inputStream - the input stream in XML format.

Returns:

the XML as an element.

Throws:

java.lang.Exception - any error.

write

void write(Element xml)
    throws java.io.IOException

Writes an XML element.

Parameters:

xml - the non-null XML element to write.

Throws:

java.io.IOException

write

void write(Element xml,
           boolean prettyPrint)
    throws java.io.IOException

Writes an XML element.

Parameters:

xml - the non-null XML element to write.

prettyPrint - if spaces need to be inserted to make the output more readable

Throws:

java.io.IOException

write

void write(Element xml,
           boolean prettyPrint,
           int indent)
    throws java.io.IOException

Writes an XML element.

Parameters:

xml - the non-null XML element to write.

prettyPrint - if spaces need to be inserted to make the output more readable

indent - how many spaces to indent the element.

Throws:

java.io.IOException