com.eteks.sweethome3d.io

Class XMLWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.eteks.sweethome3d.io.XMLWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class XMLWriter
extends java.io.FilterWriter

A simple XML writer able to write XML elements, their attributes and texts, indenting child elements.

Author:

Emmanuel Puybaret

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
XMLWriter(java.io.OutputStream out) Creates a writer in the given output stream encoded in UTF-8.

Method Summary

Modifier and Type	Method and Description
void	write(char[] buffer, int offset, int length) Writes the given characters array as the content of the current element.
void	write(int c) Writes the given character as the content of the current element.
void	write(java.lang.String str, int offset, int length) Writes the given string as the content of the current element.
void	writeAttribute(java.lang.String name, java.lang.String value) Writes the attribute of the given name with its value in the tag of the last started element.
void	writeAttribute(java.lang.String name, java.lang.String value, java.lang.String defaultValue) Writes the name and the value of an attribute in the tag of the last started element, except if value equals defaultValue.
void	writeBigDecimalAttribute(java.lang.String name, java.math.BigDecimal value) Writes the name and the value of an attribute in the tag of the last started element, except if value equals null.
void	writeBooleanAttribute(java.lang.String name, boolean value, boolean defaultValue) Writes the name and the boolean value of an attribute in the tag of the last started element, except if value equals defaultValue.
void	writeColorAttribute(java.lang.String name, java.lang.Integer color) Writes the name and the color value of an attribute in the tag of the last started element, except if value equals null.
void	writeEndElement() Writes an end tag for the given element.
void	writeFloatAttribute(java.lang.String name, float value) Writes the attribute of the given name with its float value in the tag of the last started element.
void	writeFloatAttribute(java.lang.String name, java.lang.Float value) Writes the name and the float value of an attribute in the tag of the last started element, except if value equals null.
void	writeFloatAttribute(java.lang.String name, float value, float defaultValue) Writes the name and the float value of an attribute in the tag of the last started element, except if value equals defaultValue.
void	writeIntegerAttribute(java.lang.String name, int value) Writes the attribute of the given name with its integer value in the tag of the last started element.
void	writeIntegerAttribute(java.lang.String name, int value, int defaultValue) Writes the name and the integer value of an attribute in the tag of the last started element, except if value equals defaultValue.
void	writeLongAttribute(java.lang.String name, long value) Writes the attribute of the given name with its long value in the tag of the last started element.
void	writeLongAttribute(java.lang.String name, java.lang.Long value) Writes the name and the long value of an attribute in the tag of the last started element, except if value equals null.
void	writeStartElement(java.lang.String element) Writes a start tag for the given element.
void	writeText(java.lang.String text) Writes the given text as the content of the current element.

Methods inherited from class java.io.FilterWriter

close, flush

Methods inherited from class java.io.Writer

append, append, append, write, write

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 out)
          throws java.io.IOException

Creates a writer in the given output stream encoded in UTF-8.

Throws:

java.io.IOException

Method Detail

writeStartElement

public void writeStartElement(java.lang.String element)
                       throws java.io.IOException

Writes a start tag for the given element.

Throws:

java.io.IOException

writeEndElement

public void writeEndElement()
                     throws java.io.IOException

Writes an end tag for the given element.

Throws:

java.io.IOException

writeAttribute

public void writeAttribute(java.lang.String name,
                           java.lang.String value)
                    throws java.io.IOException

Writes the attribute of the given name with its value in the tag of the last started element.

Throws:

java.io.IOException

writeAttribute

public void writeAttribute(java.lang.String name,
                           java.lang.String value,
                           java.lang.String defaultValue)
                    throws java.io.IOException

Writes the name and the value of an attribute in the tag of the last started element, except if value equals defaultValue.

Throws:

java.io.IOException

writeIntegerAttribute

public void writeIntegerAttribute(java.lang.String name,
                                  int value)
                           throws java.io.IOException

Writes the attribute of the given name with its integer value in the tag of the last started element.

Throws:

java.io.IOException

writeIntegerAttribute

public void writeIntegerAttribute(java.lang.String name,
                                  int value,
                                  int defaultValue)
                           throws java.io.IOException

Writes the name and the integer value of an attribute in the tag of the last started element, except if value equals defaultValue.

Throws:

java.io.IOException

writeLongAttribute

public void writeLongAttribute(java.lang.String name,
                               long value)
                        throws java.io.IOException

Writes the attribute of the given name with its long value in the tag of the last started element.

Throws:

java.io.IOException

writeLongAttribute

public void writeLongAttribute(java.lang.String name,
                               java.lang.Long value)
                        throws java.io.IOException

Writes the name and the long value of an attribute in the tag of the last started element, except if value equals null.

Throws:

java.io.IOException

writeFloatAttribute

public void writeFloatAttribute(java.lang.String name,
                                float value)
                         throws java.io.IOException

Writes the attribute of the given name with its float value in the tag of the last started element.

Throws:

java.io.IOException

writeFloatAttribute

public void writeFloatAttribute(java.lang.String name,
                                float value,
                                float defaultValue)
                         throws java.io.IOException

Writes the name and the float value of an attribute in the tag of the last started element, except if value equals defaultValue.

Throws:

java.io.IOException

writeFloatAttribute

public void writeFloatAttribute(java.lang.String name,
                                java.lang.Float value)
                         throws java.io.IOException

Writes the name and the float value of an attribute in the tag of the last started element, except if value equals null.

Throws:

java.io.IOException

writeBigDecimalAttribute

public void writeBigDecimalAttribute(java.lang.String name,
                                     java.math.BigDecimal value)
                              throws java.io.IOException

Writes the name and the value of an attribute in the tag of the last started element, except if value equals null.

Throws:

java.io.IOException

writeBooleanAttribute

public void writeBooleanAttribute(java.lang.String name,
                                  boolean value,
                                  boolean defaultValue)
                           throws java.io.IOException

Writes the name and the boolean value of an attribute in the tag of the last started element, except if value equals defaultValue.

Throws:

java.io.IOException

writeColorAttribute

public void writeColorAttribute(java.lang.String name,
                                java.lang.Integer color)
                         throws java.io.IOException

Writes the name and the color value of an attribute in the tag of the last started element, except if value equals null. The color is written in hexadecimal.

Throws:

java.io.IOException

writeText

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

Writes the given text as the content of the current element.

Throws:

java.io.IOException

write

public void write(int c)
           throws java.io.IOException

Writes the given character as the content of the current element.

Overrides:

write in class java.io.FilterWriter

Throws:

java.io.IOException

write

public void write(char[] buffer,
                  int offset,
                  int length)
           throws java.io.IOException

Writes the given characters array as the content of the current element.

Overrides:

write in class java.io.FilterWriter

Throws:

java.io.IOException

write

public void write(java.lang.String str,
                  int offset,
                  int length)
           throws java.io.IOException

Writes the given string as the content of the current element.

Overrides:

write in class java.io.FilterWriter

Throws:

java.io.IOException