sirius.kernel.xml

Class XMLStructuredOutput

java.lang.Object

sirius.kernel.xml.AbstractStructuredOutput

sirius.kernel.xml.XMLStructuredOutput

All Implemented Interfaces:

StructuredOutput

Direct Known Subclasses:

XMLGenerator

public class XMLStructuredOutput
extends AbstractStructuredOutput

Represents a StructuredOutput emitting XML data.

Can be used to construct XML using the StructuredOutput interface.

Nested Class Summary

Nested classes/interfaces inherited from class sirius.kernel.xml.AbstractStructuredOutput

AbstractStructuredOutput.Element, AbstractStructuredOutput.ElementType, AbstractStructuredOutput.TagBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputStream	out

Fields inherited from class sirius.kernel.xml.AbstractStructuredOutput

nesting

Constructor Summary

Constructors

Constructor and Description
XMLStructuredOutput(OutputStream out) Creates a new output writing to the given output stream.
XMLStructuredOutput(OutputStream output, Charset encoding, String doctype) Creates a new output writing to the given output stream.
XMLStructuredOutput(OutputStream output, String doctype) Creates a new output writing to the given output stream.

Method Summary

Modifier and Type	Method and Description
StructuredOutput	beginOutput(String rootElement) Starts the output with the given root element.
StructuredOutput	beginOutput(String rootElement, Attribute... attr) Starts the output with the given root element and attributes
StructuredOutput	beginResult() Starts the result with a default root element ("result").
StructuredOutput	beginResult(String name) Starts the result by specifying the name of the root element.
AbstractStructuredOutput.TagBuilder	buildBegin(String rootElement) Creates a AbstractStructuredOutput.TagBuilder used to fluently create the root element.
void	close() Closes the underlying stream
protected void	endArray(String name) Must be implemented by subclasses to end an array.
protected void	endObject(String name) Must be implemented by subclasses to end an object.
void	endOutput() Closes the output and this XML document.
void	endResult() Finishes (closes) the result
StructuredOutput	propertyIfFilled(String name, Object data) Adds a property to the current object.
protected void	startArray(String name) Must be implemented by subclasses to start a new array.
protected void	startObject(String name, Attribute... attributes) Must be implemented by subclasses to start a new object.
StructuredOutput	text(Object text) Creates a text node for the current node.
protected void	writeProperty(String name, Object value) Must be implemented by subclasses to generate a property.

Methods inherited from class sirius.kernel.xml.AbstractStructuredOutput

array, array, beginArray, beginObject, beginObject, buildObject, endArray, endObject, getCurrentType, isCurrentObjectEmpty, nullsafeProperty, property

Methods inherited from class java.lang.Object

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

Field Detail

out

protected OutputStream out

Constructor Detail

XMLStructuredOutput

public XMLStructuredOutput(@Nonnull
                           OutputStream out)

Creates a new output writing to the given output stream.

Parameters:

out - the stream used as destination for the generated xml

XMLStructuredOutput

public XMLStructuredOutput(@Nonnull
                           OutputStream output,
                           @Nullable
                           String doctype)

Creates a new output writing to the given output stream.

Parameters:

output - the stream used as destination for the generated xml

doctype - the doc type used in the XML header

XMLStructuredOutput

public XMLStructuredOutput(@Nonnull
                           OutputStream output,
                           @Nonnull
                           Charset encoding,
                           @Nullable
                           String doctype)

Creates a new output writing to the given output stream.

Parameters:

output - the stream used as destination for the generated xml

encoding - the charset used to encode the output

doctype - the doc type used in the XML header

Method Detail

endArray

protected void endArray(String name)

Description copied from class: AbstractStructuredOutput

Must be implemented by subclasses to end an array.

Specified by:

endArray in class AbstractStructuredOutput

Parameters:

name - the name of the array property to close

endObject

protected void endObject(String name)

Description copied from class: AbstractStructuredOutput

Must be implemented by subclasses to end an object.

Specified by:

endObject in class AbstractStructuredOutput

Parameters:

name - the name of the object to close

beginResult

public StructuredOutput beginResult()

Description copied from interface: StructuredOutput

Starts the result with a default root element ("result").

Returns:

the output itself for fluent method calls

beginResult

public StructuredOutput beginResult(String name)

Description copied from interface: StructuredOutput

Starts the result by specifying the name of the root element.

Parameters:

name - the name of the root element

Returns:

the output itself for fluent method calls

beginOutput

public StructuredOutput beginOutput(@Nonnull
                                    String rootElement)

Starts the output with the given root element.

Parameters:

rootElement - the name of the root element of the generated document.

Returns:

the output itself for fluent method calls

beginOutput

public StructuredOutput beginOutput(@Nonnull
                                    String rootElement,
                                    Attribute... attr)

Starts the output with the given root element and attributes

Parameters:

rootElement - the name of the root element of the generated document.

attr - the attributes for the root element

Returns:

the output itself for fluent method calls

buildBegin

@CheckReturnValue
public AbstractStructuredOutput.TagBuilder buildBegin(@Nonnull
                                                                        String rootElement)

Creates a AbstractStructuredOutput.TagBuilder used to fluently create the root element.

Parameters:

rootElement - name of the root element

Returns:

a tag builder which can be used to build the root element

endOutput

public void endOutput()

Closes the output and this XML document.

endResult

public void endResult()

Description copied from interface: StructuredOutput

Finishes (closes) the result

Specified by:

endResult in interface StructuredOutput

Overrides:

endResult in class AbstractStructuredOutput

startArray

protected void startArray(String name)

Description copied from class: AbstractStructuredOutput

Must be implemented by subclasses to start a new array.

Specified by:

startArray in class AbstractStructuredOutput

Parameters:

name - the name of the array property.

startObject

protected void startObject(String name,
                           Attribute... attributes)

Description copied from class: AbstractStructuredOutput

Must be implemented by subclasses to start a new object.

Specified by:

startObject in class AbstractStructuredOutput

Parameters:

name - the name of the object

attributes - the attributes of the object

writeProperty

protected void writeProperty(String name,
                             Object value)

Description copied from class: AbstractStructuredOutput

Must be implemented by subclasses to generate a property.

Specified by:

writeProperty in class AbstractStructuredOutput

Parameters:

name - the name of the property

value - the value of the property

propertyIfFilled

public StructuredOutput propertyIfFilled(@Nonnull
                                         String name,
                                         @Nullable
                                         Object data)

Adds a property to the current object.

This will create a property only if the specified data object is not null. Else no property is created.

Parameters:

name - the name of the property

data - the value of the property

Returns:

the output itself for fluent method calls

text

public StructuredOutput text(Object text)

Creates a text node for the current node.

Parameters:

text - the text to be added to the current node

Returns:

the output itself for fluent method calls

close

public void close()
           throws IOException

Closes the underlying stream

Throws:

IOException - if an IO error occurs while closing the stream