com.bonzaiengine.io.format

Class XmlWriter

java.lang.Object

com.bonzaiengine.io.format.XmlWriter

All Implemented Interfaces:

ITagWriter, java.io.Closeable, java.lang.AutoCloseable

public final class XmlWriter
extends java.lang.Object
implements ITagWriter

Help writing simple XML files, with formatting support.

Nested Class Summary

Nested classes/interfaces inherited from interface com.bonzaiengine.io.format.ITagWriter

ITagWriter.Tag

Constructor Summary

Constructors

Constructor and Description
XmlWriter(java.io.OutputStream os)

Method Summary

Modifier and Type	Method and Description
void	close()
void	endTag() Close the last open tag
void	setAutoIndent(boolean indent) Indent tag (tab)
void	setTagOnNewLine(boolean tagOnNewLine) Line break on a new tag
void	writeTag(java.lang.Object tag)
void	writeTagAttribute(java.lang.Object attribute, java.lang.String value) Key/value atttribute
void	writeTagContent(java.lang.String text) This functionnality is deprecated as Json does not support it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlWriter

public XmlWriter(java.io.OutputStream os)
          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setTagOnNewLine

public final void setTagOnNewLine(boolean tagOnNewLine)

Line break on a new tag

setAutoIndent

public final void setAutoIndent(boolean indent)

Indent tag (tab)

writeTag

public final void writeTag(java.lang.Object tag)
                    throws java.io.IOException

Specified by:

writeTag in interface ITagWriter

Parameters:

tag - write tag.toString()

Throws:

java.io.IOException

See Also:

ITagWriter.endTag()

writeTagAttribute

public final void writeTagAttribute(java.lang.Object attribute,
                                    java.lang.String value)
                             throws java.io.IOException

Description copied from interface: ITagWriter

Key/value atttribute

Specified by:

writeTagAttribute in interface ITagWriter

Parameters:

attribute - write the attribute key attribute.toString()

value - write the attribute value

Throws:

java.io.IOException

writeTagContent

public final void writeTagContent(java.lang.String text)
                           throws java.io.IOException

Description copied from interface: ITagWriter

This functionnality is deprecated as Json does not support it.
Using it will limit of using xml format.

Specified by:

writeTagContent in interface ITagWriter

Throws:

java.io.IOException

endTag

public final void endTag()
                  throws java.io.IOException

Description copied from interface: ITagWriter

Close the last open tag

Specified by:

endTag in interface ITagWriter

Throws:

java.io.IOException

See Also:

ITagWriter.writeTag(Object)

close

public final void close()
                 throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException