org.primordion.xholon.io.xml

Interface IXmlWriter

All Known Implementing Classes:

CherryTreeStrWriter, CsvStrWriter, HtmlFormStrWriter, JsonStrWriter, Xholon2Gml, Xholon2GraphML, Xholon2Xgmml, XmlStrWriter, XmlWriter, YamlStrWriter

public interface IXmlWriter

The abstract interface for classes that write XML.

Since:

0.8.1 (Created on December 17, 2009)

See Also:

Xholon Project website

Method Summary

Methods

Modifier and Type	Method and Description
void	createNew(java.lang.Object out) Create a new instance of an XML writer, able to write to out.
void	flush() Write any cached data to the underlying output mechanism.
java.lang.String	getWriterName() Gets the name of the XmlWriter.
boolean	isShouldWriteAllPorts() Whether or not to write an attribute with the name "AllPorts".
boolean	isShouldWriteVal() Whether or not to write an attribute with the name "Val".
void	setShouldWriteAllPorts(boolean shouldWriteAllPorts) Whether or not to write an attribute with the name "AllPorts".
void	setShouldWriteVal(boolean shouldWriteVal) Whether or not to write an attribute with the name "Val".
void	writeAttribute(java.lang.String name, java.lang.String value) Writes an attribute to the output stream.
void	writeComment(java.lang.String data) Writes an xml comment.
void	writeEndDocument() Closes any start tags and writes corresponding end tags.
void	writeEndElement(java.lang.String name) Writes an end tag to the output.
void	writeEndElement(java.lang.String name, java.lang.String namespaceURI) Writes an end tag to the output.
void	writeNamespace(java.lang.String prefix, java.lang.String namespaceURI) Writes a namespace to the output stream.
void	writeStartDocument() Write the XML Declaration.
void	writeStartElement(java.lang.String name) Writes a start tag to the output.
void	writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) Writes a start tag to the output
void	writeText(java.lang.String text) Write text to the output.

Method Detail

createNew

void createNew(java.lang.Object out)

Create a new instance of an XML writer, able to write to out.

Parameters:

out - An output file, stream, string, or other type of writer. This must be an instance of java.io.Writer.

writeStartDocument

void writeStartDocument()

Write the XML Declaration.

writeEndDocument

void writeEndDocument()

Closes any start tags and writes corresponding end tags.

writeStartElement

void writeStartElement(java.lang.String prefix,
                     java.lang.String localName,
                     java.lang.String namespaceURI)

Writes a start tag to the output

Parameters:

localName - local name of the tag, may not be null

prefix - the prefix of the tag, may not be null

namespaceURI - the uri to bind the prefix to, may not be null

writeStartElement

void writeStartElement(java.lang.String name)

Writes a start tag to the output.

Parameters:

name -

writeEndElement

void writeEndElement(java.lang.String name,
                   java.lang.String namespaceURI)

Writes an end tag to the output. For use by XPP which requires a namespace if one was provided in the writeStartElement().

Parameters:

name -

namespaceURI -

writeEndElement

void writeEndElement(java.lang.String name)

Writes an end tag to the output.

Parameters:

name -

writeNamespace

void writeNamespace(java.lang.String prefix,
                  java.lang.String namespaceURI)

Writes a namespace to the output stream. For use by StAX.

Parameters:

prefix - the prefix to bind this namespace to

namespaceURI - the uri to bind the prefix to

writeAttribute

void writeAttribute(java.lang.String name,
                  java.lang.String value)

Writes an attribute to the output stream.

Parameters:

name -

value -

writeText

void writeText(java.lang.String text)

Write text to the output.

Parameters:

text -

writeComment

void writeComment(java.lang.String data)

Writes an xml comment.

Parameters:

data -

getWriterName

java.lang.String getWriterName()

Gets the name of the XmlWriter.

Returns:

A name, for example "XmlStaxWriter" or "XmlXppWriter".

flush

void flush()

Write any cached data to the underlying output mechanism.

isShouldWriteVal

boolean isShouldWriteVal()

Whether or not to write an attribute with the name "Val".

setShouldWriteVal

void setShouldWriteVal(boolean shouldWriteVal)

Whether or not to write an attribute with the name "Val".

isShouldWriteAllPorts

boolean isShouldWriteAllPorts()

Whether or not to write an attribute with the name "AllPorts".

setShouldWriteAllPorts

void setShouldWriteAllPorts(boolean shouldWriteAllPorts)

Whether or not to write an attribute with the name "AllPorts".