to.etc.xml

Class XmlWriter

java.lang.Object

java.io.Writer

to.etc.util.IndentWriter

to.etc.xml.XmlWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class XmlWriter
extends IndentWriter

Small utility class to write formatted XML documents. This class writes it's data to a printstream. The stream is never closed. The data is formatted and nested appropriately by indenting tags. XML cdata is properly escaped (replacing < by &lt; and the like.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
XmlWriter()
XmlWriter(Writer w)

Method Summary

Modifier and Type	Method and Description
void	attr(String name, Object value)
void	attr(String name, String value)
void	attrForDomApi(String name, String value) Renders attribute with string value, complying to DOM API 5.2 Character Escaping http://www.w3.org/TR/2000/WD-xml-c14n-20000119.html#charescaping
void	cdata(String s) Writes string data.
void	close() XMLWriters cannot be closed: ignore.
void	dumpBean(Object o)
void	endTag(boolean complete)
void	init(Writer w, int taglvl)
void	startTag(String tn)
void	tag(String tn)
void	tag(String tn, Object... ar)
void	tag(String tn, String... attrvalueset)
void	tag(String tn, String attrs) Writes a new XML tag.
void	tagendnl()
void	tagfull(String tn) Writes a complete tag (open AND close) without attributes.
void	tagfull(String tn, boolean onoff) Writes a tag, a #text content and the end tag on one line.
void	tagfull(String tn, Boolean onoff) Writes a tag, a #text content and the end tag on one line.
void	tagfull(String tn, Date dt) Writes a tag, a #text content and the end tag on one line.
void	tagfull(String tn, int val) Writes a tag, a #text content and the end tag on one line.
void	tagfull(String tn, long val) Writes a tag, a #text content and the end tag on one line.
void	tagfull(String tn, Number val)
void	tagfull(String tn, String text) Writes a tag, a #text content and the end tag on one line.
void	tagfull(String tn, String attrs, String text) Writes a tag with the given attributes, a #text content and the end tag on one line.
void	tagnl(String tn, String... attrvalueset)
void	tagonly(String tn, String... attrvalueset) Outputs a tag AND parameters ONLY, i.e.
void	tagonlynl(String tn, String... attrvalueset)
void	unclosed()
void	wraw(String s) Writes data without replacing stuff; it does expand newlines to indent.
void	writeAttr(String name, String value)

Methods inherited from class to.etc.util.IndentWriter

dec, flush, forceNewline, getStdoutWriter, getWriter, inc, indent, isIndentEnabled, print, println, println, setInd, setIndentEnabled, setSpacesPerIndent, write, write, writeRaw, writeRaw, writeRaw

Methods inherited from class java.io.Writer

append, append, append, write, 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()

XmlWriter

public XmlWriter(Writer w)

Method Detail

init

public void init(Writer w,
                 int taglvl)

Overrides:

init in class IndentWriter

wraw

public void wraw(String s)
          throws IOException

Writes data without replacing stuff; it does expand newlines to indent.

Parameters:

s -

Throws:

IOException

writeAttr

public void writeAttr(String name,
                      String value)
               throws IOException

Throws:

IOException

cdata

public void cdata(String s)
           throws IOException

Writes string data. This escapes XML control characters to their entity equivalent. This does NOT indent data with newlines, because string data in a content block may not change.

Throws:

IOException

unclosed

public void unclosed()

tag

public void tag(String tn,
                String attrs)
         throws IOException

Writes a new XML tag. The attrs field must at least contain a '>' to close the tag. If you want the tag to be the only one on the line then add a linefeed to the attrs field also.

Parameters:

tn - The tag name without braces

attrs - attributes.

Throws:

IOException

tagnl

public void tagnl(String tn,
                  String... attrvalueset)
           throws IOException

Throws:

IOException

tag

public void tag(String tn,
                Object... ar)
         throws Exception

Throws:

Exception

tag

public void tag(String tn,
                String... attrvalueset)
         throws IOException

Throws:

IOException

startTag

public void startTag(String tn)
              throws IOException

Throws:

IOException

attr

public void attr(String name,
                 String value)
          throws IOException

Throws:

IOException

attrForDomApi

public void attrForDomApi(String name,
                          String value)
                   throws IOException

Renders attribute with string value, complying to DOM API 5.2 Character Escaping http://www.w3.org/TR/2000/WD-xml-c14n-20000119.html#charescaping

Parameters:

name -

value -

Throws:

IOException

attr

public void attr(String name,
                 Object value)
          throws Exception

Throws:

Exception

endTag

public void endTag(boolean complete)
            throws IOException

Throws:

IOException

tagonly

public void tagonly(String tn,
                    String... attrvalueset)
             throws IOException

Outputs a tag AND parameters ONLY, i.e. it outputs the tag and completes it by adding />.

Parameters:

tn -

attrvalueset -

Throws:

IOException

tagonlynl

public void tagonlynl(String tn,
                      String... attrvalueset)
               throws IOException

Throws:

IOException

tag

public void tag(String tn)
         throws IOException

Throws:

IOException

tagfull

public void tagfull(String tn)
             throws IOException

Writes a complete tag (open AND close) without attributes.

Parameters:

tag -

Throws:

IOException

tagfull

public void tagfull(String tn,
                    String text)
             throws IOException

Writes a tag, a #text content and the end tag on one line.

Parameters:

tag -

text -

Throws:

IOException

tagfull

public void tagfull(String tn,
                    Date dt)
             throws IOException

Writes a tag, a #text content and the end tag on one line.

Parameters:

tag -

text -

Throws:

IOException

tagfull

public void tagfull(String tn,
                    String attrs,
                    String text)
             throws IOException

Writes a tag with the given attributes, a #text content and the end tag on one line.

Parameters:

tag -

attrs -

text -

Throws:

IOException

tagfull

public void tagfull(String tn,
                    int val)
             throws IOException

Writes a tag, a #text content and the end tag on one line.

Parameters:

tag -

text -

Throws:

IOException

tagfull

public void tagfull(String tn,
                    long val)
             throws IOException

Writes a tag, a #text content and the end tag on one line.

Parameters:

tag -

text -

Throws:

IOException

tagfull

public void tagfull(String tn,
                    Number val)
             throws IOException

Throws:

IOException

tagfull

public void tagfull(String tn,
                    boolean onoff)
             throws IOException

Writes a tag, a #text content and the end tag on one line.

Parameters:

tag -

text -

Throws:

IOException

tagfull

public void tagfull(String tn,
                    Boolean onoff)
             throws IOException

Writes a tag, a #text content and the end tag on one line.

Parameters:

tag -

text -

Throws:

IOException

tagendnl

public void tagendnl()
              throws IOException

Throws:

IOException

close

public void close()
           throws IOException

XMLWriters cannot be closed: ignore.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class IndentWriter

Throws:

IOException

See Also:

Closeable.close()

dumpBean

public void dumpBean(Object o)
              throws IOException

Throws:

IOException