org.marre.xml
Interface XmlWriter

All Known Implementing Classes:

TextXmlWriter, WbxmlWriter

public interface XmlWriter

Simple interface to write XML documents. Mainly created to make it simple to create both XML and WBXML documents.

Version:

$Id: XmlWriter.java,v 1.7 2004/12/07 20:03:21 c95men Exp $

Author:

Markus Eriksson

Method Summary

void	addCharacters(char[] ch, int start, int length) Adds a segment of text.
void	addCharacters(java.lang.String str) Adds a segment of text.
void	addEmptyElement(java.lang.String tag) Adds an empty element tag.
void	addEmptyElement(java.lang.String tag, XmlAttribute[] attribs) Adds an empty start element tag with attributes.
void	addEndElement() Adds an end element tag.
void	addStartElement(java.lang.String tag) Adds a start element tag.
void	addStartElement(java.lang.String tag, XmlAttribute[] attribs) Adds a start element tag with attributes.
void	flush() Flushes the xml document.
void	setDoctype(java.lang.String publicID) Sets a public ID doctype.
void	setDoctype(java.lang.String name, java.lang.String systemURI) Sets a system URI doctype.
void	setDoctype(java.lang.String name, java.lang.String publicID, java.lang.String publicURI) Sets a public ID doctype.

Method Detail

setDoctype

public void setDoctype(java.lang.String publicID)

Sets a public ID doctype. Must be set before any of the add or flush methods.

Parameters:

publicID - XML public ID

setDoctype

public void setDoctype(java.lang.String name,
                       java.lang.String systemURI)

Sets a system URI doctype. Must be set before any of the add or flush methods.

Parameters:

name - Name

systemURI - System URI

setDoctype

public void setDoctype(java.lang.String name,
                       java.lang.String publicID,
                       java.lang.String publicURI)

Sets a public ID doctype. Must be set before any of the add or flush methods.

Parameters:

name - Name

publicID - PublicID

publicURI - PublicURI

addStartElement

public void addStartElement(java.lang.String tag)
                     throws java.io.IOException

Adds a start element tag. Ex: <TAG>

Parameters:

tag - tag

Throws:

java.io.IOException - io error

addStartElement

public void addStartElement(java.lang.String tag,
                            XmlAttribute[] attribs)
                     throws java.io.IOException

Adds a start element tag with attributes. Ex: <TAG attrib="value">

Parameters:

tag - Tag

attribs - Attributes

Throws:

java.io.IOException - io error

addEmptyElement

public void addEmptyElement(java.lang.String tag)
                     throws java.io.IOException

Adds an empty element tag. Ex: <TAG/>

Parameters:

tag - Tag

Throws:

java.io.IOException - io error

addEmptyElement

public void addEmptyElement(java.lang.String tag,
                            XmlAttribute[] attribs)
                     throws java.io.IOException

Adds an empty start element tag with attributes. Ex: <TAG attrib="value"/>

Parameters:

tag - Tag

attribs - Attributes

Throws:

java.io.IOException - io error

addEndElement

public void addEndElement()
                   throws java.io.IOException

Adds an end element tag. Ex </TAG>

Throws:

java.io.IOException - io error

addCharacters

public void addCharacters(char[] ch,
                          int start,
                          int length)
                   throws java.io.IOException

Adds a segment of text.

Parameters:

ch - The chars to add

start - Start offset of the ch array.

length - Number of chars to add

Throws:

java.io.IOException - io error

addCharacters

public void addCharacters(java.lang.String str)
                   throws java.io.IOException

Adds a segment of text.

Parameters:

str - Text to add

Throws:

java.io.IOException - io error

flush

public void flush()
           throws java.io.IOException

Flushes the xml document. Must be called to be sure that the document is correctly created.

Throws:

java.io.IOException - io error