Module org.panteleyev.commons

Package org.panteleyev.commons.xml

Class XMLStreamWriterWrapper

java.lang.Object

org.panteleyev.commons.xml.XMLStreamWriterWrapper

All Implemented Interfaces:

AutoCloseable

public class XMLStreamWriterWrapper
extends Object
implements AutoCloseable

Convenience wrapper for XMLStreamWriter instances.

Attribute values are converted to string accoring to the following rules:

Class	String Value
String	as is
LocalDateTime	ISO date time
Enum	Enum.name()
LocalDate	LocalDate.toEpochDay() or ISO date depending on options.
Object	Object.toString()

Method Summary

Modifier and Type	Method	Description
XMLStreamWriterWrapper	attribute(QName name, Object value)	Writes a single attribute.
XMLStreamWriterWrapper	attributes(Map<QName,?> attributes)	Writes several attributes.
void	close()	Closes the writer.
void	document(Runnable body)	Writes XML document.
void	document(QName name, Runnable body)	Writes XML document with root element.
XMLStreamWriterWrapper	element(QName name, Runnable body)	Writes XML element.
XMLStreamWriterWrapper	element(QName name, Map<QName,?> attributes)	Writes element with attributes.
void	flush()	Flushes the writer.
static XMLStreamWriterWrapper	newInstance(OutputStream out)	Creates an instance of XMLStreamWriterWrapper with default options.
static XMLStreamWriterWrapper	newInstance(OutputStream out, Set<SerializationOption> options)	Creates an instance of XMLStreamWriterWrapper with specified options.
XMLStreamWriterWrapper	text(String text)	Writes element text.
XMLStreamWriterWrapper	textElement(QName name, Object value)	Writes XML element with text.
XMLStreamWriterWrapper	textElement(QName name, Map<QName,?> attributes, Object value)	Writes element with attributes and text.

Methods inherited from class java.lang.Object

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

Method Details

newInstance

public static XMLStreamWriterWrapper newInstance(OutputStream out)

Creates an instance of XMLStreamWriterWrapper with default options.

Parameters:

out - output stream

Returns:

instance of XMLStreamWriterWrapper

newInstance

public static XMLStreamWriterWrapper newInstance(OutputStream out,
 Set<SerializationOption> options)

Creates an instance of XMLStreamWriterWrapper with specified options.

Parameters:

out - output stream

options - set of options

Returns:

instance of XMLStreamWriterWrapper

close

public void close()

Closes the writer. See XMLStreamWriter.close().

Specified by:

close in interface AutoCloseable

flush

public void flush()

Flushes the writer. See XMLStreamWriter.flush().

document

public void document(Runnable body)

Writes XML document.

Parameters:

body - block that generates document XML

document

public void document(QName name,
 Runnable body)

Writes XML document with root element.

Parameters:

name - root element name

body - block that generates document XML

element

public XMLStreamWriterWrapper element(QName name,
 Runnable body)

Writes XML element.

Parameters:

name - element name

body - block that generates element XML: attributes, nodes, etc.

Returns:

this instance

textElement

public XMLStreamWriterWrapper textElement(QName name,
 Object value)

Writes XML element with text.
<localName>text</localName>

Parameters:

name - element name

value - value converted to element text

Returns:

this instance

element

public XMLStreamWriterWrapper element(QName name,
 Map<QName,?> attributes)

Writes element with attributes.

Parameters:

name - element name

attributes - attributes

Returns:

this instance

textElement

public XMLStreamWriterWrapper textElement(QName name,
 Map<QName,?> attributes,
 Object value)

Writes element with attributes and text.

Parameters:

name - element local name

attributes - attributes

value - value converted to element text

Returns:

this instance

attribute

public XMLStreamWriterWrapper attribute(QName name,
 Object value)

Writes a single attribute.

Parameters:

name - attribute name

value - attribute value

Returns:

this instance

attributes

public XMLStreamWriterWrapper attributes(Map<QName,?> attributes)

Writes several attributes.

Parameters:

attributes - attributes

Returns:

this instance

text

public XMLStreamWriterWrapper text(String text)

Writes element text.

Parameters:

text - element text

Returns:

this instance