io.milton.http

Class XmlWriter

java.lang.Object

io.milton.http.XmlWriter

public class XmlWriter
extends Object

Lightweight XML generation. Gives the programmer fine grained control of the generated xml, including whitespace.

The XML is not guaranteed to be parseable.

Author:

brad

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XmlWriter.Element Represents an element which is currently being written
static class	XmlWriter.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset
protected OutputStream	out

Constructor Summary

Constructors

Constructor and Description
XmlWriter(OutputStream out)
XmlWriter(OutputStream out, Charset charset)

Method Summary

Modifier and Type	Method and Description
XmlWriter.Element	begin(String name)
XmlWriter.Element	begin(String nsPrefix, String name)
void	close(String name) Write a closing tag for the given name
void	close(String namespace, String name) Write a closing tag, Eg
void	flush() Send data and reinitializes buffer.
boolean	isAllowNewlines()
void	newLine()
void	open(String name) Write an opening tag
void	open(String namespace, String name) Write an opening tag
void	setAllowNewlines(boolean allowNewlines)
static Charset	utf8()
void	writeData(String data) Write a CDATA segment.
void	writeElement(String nsPrefix, String nsUrl, String name, XmlWriter.Type type)
void	writeElement(String namespace, String name, XmlWriter.Type type)
void	writeProperty(String name)
void	writeProperty(String namespace, String name)
void	writeProperty(String namespace, String name, String value)
void	writeProperty(String namespace, String namespaceInfo, String name, String value) Convenience method to write a single element containing a piece of text
void	writeText(String text) Append plain text.
void	writeXMLHeader()

Methods inherited from class java.lang.Object

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

Field Detail

out

protected final OutputStream out

charset

protected final Charset charset

Constructor Detail

XmlWriter

public XmlWriter(OutputStream out,
                 Charset charset)

XmlWriter

public XmlWriter(OutputStream out)

Method Detail

utf8

public static Charset utf8()

writeProperty

public void writeProperty(String namespace,
                          String namespaceInfo,
                          String name,
                          String value)

Convenience method to write a single element containing a piece of text

Parameters:

namespace - - optional, namespace prefix

namespaceInfo - - optional, namespace url

name - - the local name of the element to create

value - - the raw text to insert into the element

writeProperty

public void writeProperty(String namespace,
                          String name,
                          String value)

writeProperty

public void writeProperty(String namespace,
                          String name)

writeProperty

public void writeProperty(String name)

writeElement

public void writeElement(String namespace,
                         String name,
                         XmlWriter.Type type)

open

public void open(String namespace,
                 String name)

Write an opening tag

Parameters:

namespace -

name -

close

public void close(String namespace,
                  String name)

Write a closing tag, Eg

Parameters:

namespace -

name -

open

public void open(String name)

Write an opening tag

Parameters:

name -

close

public void close(String name)

Write a closing tag for the given name

Parameters:

name -

begin

public XmlWriter.Element begin(String name)

begin

public XmlWriter.Element begin(String nsPrefix,
                               String name)

writeElement

public void writeElement(String nsPrefix,
                         String nsUrl,
                         String name,
                         XmlWriter.Type type)

writeText

public void writeText(String text)

Append plain text.

Parameters:

text - Text to append

writeData

public void writeData(String data)

Write a CDATA segment.

Parameters:

data - Data to append

writeXMLHeader

public void writeXMLHeader()

flush

public void flush()

Send data and reinitializes buffer.

newLine

public void newLine()

isAllowNewlines

public boolean isAllowNewlines()

setAllowNewlines

public void setAllowNewlines(boolean allowNewlines)