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

Implements 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()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	XMLStreamWriterWrapper.Option	Serialization options.

Method Summary

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

element

public XMLStreamWriterWrapper element(String localName,
 Runnable body)

Writes XML element.

Parameters:

localName - element local name

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

Returns:

this instance

element

public XMLStreamWriterWrapper element(String localName,
 String text)

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

Parameters:

localName - element local name

text - element text

Returns:

this instance

element

public XMLStreamWriterWrapper element(String localName,
 Map<String,?> attributes)

Writes element with attributes.

Parameters:

localName - element local name

attributes - attributes

Returns:

this instance

element

public XMLStreamWriterWrapper element(String localName,
 Map<String,?> attributes,
 String text)

Writes element with attributes and text.

Parameters:

localName - element local name

attributes - attributes

text - element text

Returns:

this instance

attribute

public XMLStreamWriterWrapper attribute(String name,
 Object value)

Writes a single attribute.

Parameters:

name - attribute name

value - attribute value

Returns:

this instance

attributes

public XMLStreamWriterWrapper attributes(Map<String,?> 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