net.lecousin.framework.xml

Class XMLWriter

java.lang.Object

net.lecousin.framework.xml.XMLWriter

public class XMLWriter
extends Object

Utility class to generate XML.

Constructor Summary

Constructors

Constructor and Description
XMLWriter(ICharacterStream.Writable.Buffered output, boolean includeXMLDeclaration, boolean pretty) Constructor.
XMLWriter(IO.Writable.Buffered output, Charset encoding, boolean includeXMLDeclaration, boolean pretty) Constructor.

Method Summary

Modifier and Type	Method and Description
IAsync<IOException>	addAttribute(CharSequence name, CharSequence value) Add an attribute to the current element.
IAsync<IOException>	addCData(CharSequence data) Add a CDATA section inside the current element.
IAsync<IOException>	addComment(CharSequence comment) Add a comment inside the current element.
IAsync<IOException>	addText(CharSequence text) Add text inside the current element.
IAsync<IOException>	closeElement() Close the current element.
IAsync<IOException>	end() End the document, close any open element, and flush the output stream.
IAsync<IOException>	endOfAttributes() Signal the end of attributes, so the opening tag can be closed and the content can start.
protected IAsync<IOException>	endOfAttributes(net.lecousin.framework.xml.XMLWriter.Context ctx)
static String	escape(CharSequence s) Escape a string to include it in XML (this is automatically called by other methods of this class when needed).
protected void	indent()
IAsync<IOException>	openElement(String namespaceURI, String localName, Map<String,String> namespaces) Open a new element.
IAsync<IOException>	start(String rootNamespaceURI, String rootLocalName, Map<String,String> namespaces) Start the document with the XML processing instruction if needed, and opening the root element.
IAsync<IOException>	write(Element element) Write the given DOM element.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLWriter

public XMLWriter(IO.Writable.Buffered output,
                 Charset encoding,
                 boolean includeXMLDeclaration,
                 boolean pretty)

Constructor.

XMLWriter

public XMLWriter(ICharacterStream.Writable.Buffered output,
                 boolean includeXMLDeclaration,
                 boolean pretty)

Constructor.

Method Detail

escape

public static String escape(CharSequence s)

Escape a string to include it in XML (this is automatically called by other methods of this class when needed).

start

public IAsync<IOException> start(String rootNamespaceURI,
                                 String rootLocalName,
                                 Map<String,String> namespaces)

Start the document with the XML processing instruction if needed, and opening the root element.

Parameters:

rootNamespaceURI - namespace of the root element

rootLocalName - name of the root element

namespaces - mapping from namespace URI to prefix, prefix may be empty for default namespace

end

public IAsync<IOException> end()

End the document, close any open element, and flush the output stream.

indent

protected void indent()

addAttribute

public IAsync<IOException> addAttribute(CharSequence name,
                                        CharSequence value)

Add an attribute to the current element.

endOfAttributes

public IAsync<IOException> endOfAttributes()

Signal the end of attributes, so the opening tag can be closed and the content can start. This is optional to call this method, as any other method writing something inside the current element will first check the opening tag is already closed or not.

endOfAttributes

protected IAsync<IOException> endOfAttributes(net.lecousin.framework.xml.XMLWriter.Context ctx)

openElement

public IAsync<IOException> openElement(String namespaceURI,
                                       String localName,
                                       Map<String,String> namespaces)

Open a new element.

closeElement

public IAsync<IOException> closeElement()

Close the current element.

addText

public IAsync<IOException> addText(CharSequence text)

Add text inside the current element.

addCData

public IAsync<IOException> addCData(CharSequence data)

Add a CDATA section inside the current element.

addComment

public IAsync<IOException> addComment(CharSequence comment)

Add a comment inside the current element.

write

public IAsync<IOException> write(Element element)

Write the given DOM element.