sirius.kernel.xml

Interface StructuredOutput

All Known Implementing Classes:

AbstractStructuredOutput, XMLGenerator, XMLStructuredOutput

public interface StructuredOutput

Interface for writing structured outputs like XML or JSON.

Method Summary

Modifier and Type	Method and Description
<E> StructuredOutput	array(String name, Collection<E> array, BiConsumer<StructuredOutput,E> arrayConsumer) Outputs the given collection as array while using the given arrayConsumer to generate the array contents.
StructuredOutput	array(String name, String elementName, Collection<?> array) Outputs the given collection as array.
StructuredOutput	beginArray(String name) Starts an array with is added to the current object as "name".
StructuredOutput	beginObject(String name) Starts a new object with the given name.
StructuredOutput	beginObject(String name, Attribute... attributes) Starts a new object with the given name 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.
StructuredOutput	endArray() Ends the currently open array.
StructuredOutput	endObject() Ends the currently open object.
void	endResult() Finishes (closes) the result
StructuredOutput	nullsafeProperty(String name, Object data) Adds a property to the current object.
StructuredOutput	property(String name, Object data) Adds a property to the current object.

Method Detail

beginResult

StructuredOutput beginResult()

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

Returns:

the output itself for fluent method calls

beginResult

StructuredOutput beginResult(@Nonnull
                             String name)

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

endResult

void endResult()

Finishes (closes) the result

beginObject

StructuredOutput beginObject(@Nonnull
                             String name)

Starts a new object with the given name.

Parameters:

name - the name of the element to start

Returns:

the output itself for fluent method calls

beginObject

StructuredOutput beginObject(@Nonnull
                             String name,
                             Attribute... attributes)

Starts a new object with the given name and attributes

Parameters:

name - the name of the object to create

attributes - the attributes to add to the object

Returns:

the output itself for fluent method calls

endObject

StructuredOutput endObject()

Ends the currently open object.

Returns:

the output itself for fluent method calls

property

StructuredOutput property(@Nonnull
                          String name,
                          @Nullable
                          Object data)

Adds a property to the current object.

Parameters:

name - the name of the property

data - the value of the property

Returns:

the output itself for fluent method calls

nullsafeProperty

StructuredOutput nullsafeProperty(@Nonnull
                                  String name,
                                  @Nullable
                                  Object data)

Adds a property to the current object.

This will create a property with the specified data as value or empty string if the value is null.

Parameters:

name - the name of the property

data - the value of the property

Returns:

the output itself for fluent method calls

beginArray

StructuredOutput beginArray(@Nonnull
                            String name)

Starts an array with is added to the current object as "name".

Parameters:

name - the name of the array

Returns:

the output itself for fluent method calls

endArray

StructuredOutput endArray()

Ends the currently open array.

Returns:

the output itself for fluent method calls

array

StructuredOutput array(@Nonnull
                       String name,
                       @Nonnull
                       String elementName,
                       @Nonnull
                       Collection<?> array)

Outputs the given collection as array.

This will create a property with the given name and the given array as value

Parameters:

name - the name of the property

elementName - the name used to generate inner elements (if required, e.g. XML)

array - the array to output

Returns:

the output itself for fluent method calls

array

<E> StructuredOutput array(@Nonnull
                           String name,
                           @Nonnull
                           Collection<E> array,
                           BiConsumer<StructuredOutput,E> arrayConsumer)

Outputs the given collection as array while using the given arrayConsumer to generate the array contents.

Type Parameters:

E - the type of elements in array

Parameters:

name - the name of the array property to create

array - the collection to generate inner elements

arrayConsumer - the consumer which creates the array content per child element in array

Returns:

the output itself for fluent method calls