org.amplecode.staxwax.writer

Interface XMLWriter

All Known Implementing Classes:

DefaultXMLStreamWriter

public interface XMLWriter

This interface provides convenience methods for XML writing.

Version:

$Id: XMLWriter.java 145 2009-06-29 14:48:33Z larshelg $

Author:

Lars Helge Overland

Method Summary

Methods

Modifier and Type	Method and Description
void	closeDocument() Writes XML end tags to start tags which have not been terminated to output.
void	closeElement() Writes an XML end tag to output.
void	closeWriter() Closes the underlying writer.
XMLStreamWriter	getXmlStreamWriter() Provides the underlying XmlStreamWriter.
void	openDocument() Writes the XML declaration to output.
void	openDocument(String encoding, String version) Writes the XML declaration to ouput.
void	openElement(String name) Writes an XML start tag to output.
void	openElement(String name, String... attributeNameValuePairs) Writes an XML start tag to output.
void	writeAttribute(String name, String value) Writes an XML attribute to output.
void	writeCData(String cData) Writes non-parsed character data to ouput.
void	writeCharacters(String characters) Writes characters to output.
void	writeElement(String name, String value) Writes an XML start tag, value, and end tag to ouput.
void	writeElement(String name, String value, String... attributeNameValuePairs) Writes an XML start tag with attributes, value, and end tag to ouput.

Method Detail

openDocument

void openDocument()

Writes the XML declaration to output.

Parameters:

encoding - the encoding the XML file.

version - the version of the XML file.

openDocument

void openDocument(String encoding,
                String version)

Writes the XML declaration to ouput.

Parameters:

encoding - the encoding the XML file.

version - the version of the XML file.

openElement

void openElement(String name)

Writes an XML start tag to output.

Parameters:

name - the name of the XML element.

openElement

void openElement(String name,
               String... attributeNameValuePairs)

Writes an XML start tag to output.

Parameters:

name - the name of the XML element.

attributeNameValuePairs - the attributes of the XML element given in key-value-pairs.

writeAttribute

void writeAttribute(String name,
                  String value)

Writes an XML attribute to output.

Parameters:

name - the attribute name.

value - the attribute value.

writeElement

void writeElement(String name,
                String value)

Writes an XML start tag, value, and end tag to ouput.

Parameters:

name - the name of the XML element.

value - the value of the XML element.

writeElement

void writeElement(String name,
                String value,
                String... attributeNameValuePairs)

Writes an XML start tag with attributes, value, and end tag to ouput.

Parameters:

name - the name of the XML element.

value - the value of the XML element.

attributeNameValuePairs - the attributes of the XML element given in key-value-pairs.

writeCharacters

void writeCharacters(String characters)

Writes characters to output.

Parameters:

characters - the characters to write.

writeCData

void writeCData(String cData)

Writes non-parsed character data to ouput.

Parameters:

cData - character data to write.

getXmlStreamWriter

XMLStreamWriter getXmlStreamWriter()

Provides the underlying XmlStreamWriter.

Returns:

the underlying XmlStreamWriter.

closeElement

void closeElement()

Writes an XML end tag to output.

Parameters:

name - the name of the XML element.

closeDocument

void closeDocument()

Writes XML end tags to start tags which have not been terminated to output.

Parameters:

encoding - the encoding of the XML file.

closeWriter

void closeWriter()

Closes the underlying writer.