sirius.kernel.xml

Class AbstractStructuredOutput

java.lang.Object

sirius.kernel.xml.AbstractStructuredOutput

All Implemented Interfaces:

StructuredOutput

Direct Known Subclasses:

XMLStructuredOutput

public abstract class AbstractStructuredOutput
extends Object
implements StructuredOutput

Basic implementation of StructuredOutput, taking care of all output independent boilerplate code.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractStructuredOutput.Element Used by internal bookkeeping, to close elements property
protected static class	AbstractStructuredOutput.ElementType Types used by internal bookkeeping
class	AbstractStructuredOutput.TagBuilder Used to fluently create a beginObject(String, Attribute...).

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AbstractStructuredOutput.Element>	nesting

Constructor Summary

Constructors

Constructor and Description
AbstractStructuredOutput()

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
AbstractStructuredOutput.TagBuilder	buildObject(String name) Creates a new object using the returned tag builder
StructuredOutput	endArray() Ends the currently open array.
protected abstract void	endArray(String name) Must be implemented by subclasses to end an array.
StructuredOutput	endObject() Ends the currently open object.
protected abstract void	endObject(String name) Must be implemented by subclasses to end an object.
void	endResult() Finishes (closes) the result
protected AbstractStructuredOutput.ElementType	getCurrentType() Returns the type of the current element.
boolean	isCurrentObjectEmpty() Determines whether the current element is empty
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.
protected abstract void	startArray(String name) Must be implemented by subclasses to start a new array.
protected abstract void	startObject(String name, Attribute... attributes) Must be implemented by subclasses to start a new object.
protected abstract void	writeProperty(String name, Object value) Must be implemented by subclasses to generate a property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface sirius.kernel.xml.StructuredOutput

beginResult, beginResult

Field Detail

nesting

protected List<AbstractStructuredOutput.Element> nesting

Constructor Detail

AbstractStructuredOutput

public AbstractStructuredOutput()

Method Detail

getCurrentType

protected AbstractStructuredOutput.ElementType getCurrentType()

Returns the type of the current element.

Returns:

the type of the current element

isCurrentObjectEmpty

public boolean isCurrentObjectEmpty()

Determines whether the current element is empty

Returns:

true if the current element has no content or children, false otherwise

beginArray

public StructuredOutput beginArray(String name)

Description copied from interface: StructuredOutput

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

Specified by:

beginArray in interface StructuredOutput

Parameters:

name - the name of the array

Returns:

the output itself for fluent method calls

array

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

Description copied from interface: StructuredOutput

Outputs the given collection as array.

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

Specified by:

array in interface StructuredOutput

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

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

Description copied from interface: StructuredOutput

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

Specified by:

array in interface StructuredOutput

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

startArray

protected abstract void startArray(String name)

Must be implemented by subclasses to start a new array.

Parameters:

name - the name of the array property.

startObject

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

Must be implemented by subclasses to start a new object.

Parameters:

name - the name of the object

attributes - the attributes of the object

endArray

protected abstract void endArray(String name)

Must be implemented by subclasses to end an array.

Parameters:

name - the name of the array property to close

endObject

protected abstract void endObject(String name)

Must be implemented by subclasses to end an object.

Parameters:

name - the name of the object to close

writeProperty

protected abstract void writeProperty(String name,
                                      Object value)

Must be implemented by subclasses to generate a property.

Parameters:

name - the name of the property

value - the value of the property

beginObject

public StructuredOutput beginObject(String name)

Description copied from interface: StructuredOutput

Starts a new object with the given name.

Specified by:

beginObject in interface StructuredOutput

Parameters:

name - the name of the element to start

Returns:

the output itself for fluent method calls

beginObject

public StructuredOutput beginObject(String name,
                                    Attribute... attributes)

Description copied from interface: StructuredOutput

Starts a new object with the given name and attributes

Specified by:

beginObject in interface StructuredOutput

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

buildObject

@CheckReturnValue
public AbstractStructuredOutput.TagBuilder buildObject(@Nonnull
                                                                         String name)

Creates a new object using the returned tag builder

Parameters:

name - the name of the object to create

Returns:

a tag builder to fluently create a new object

endArray

public StructuredOutput endArray()

Description copied from interface: StructuredOutput

Ends the currently open array.

Specified by:

endArray in interface StructuredOutput

Returns:

the output itself for fluent method calls

endObject

public StructuredOutput endObject()

Description copied from interface: StructuredOutput

Ends the currently open object.

Specified by:

endObject in interface StructuredOutput

Returns:

the output itself for fluent method calls

endResult

public void endResult()

Description copied from interface: StructuredOutput

Finishes (closes) the result

Specified by:

endResult in interface StructuredOutput

property

public StructuredOutput property(String name,
                                 Object data)

Description copied from interface: StructuredOutput

Adds a property to the current object.

Specified by:

property in interface StructuredOutput

Parameters:

name - the name of the property

data - the value of the property

Returns:

the output itself for fluent method calls

nullsafeProperty

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

Description copied from interface: StructuredOutput

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.

Specified by:

nullsafeProperty in interface StructuredOutput

Parameters:

name - the name of the property

data - the value of the property

Returns:

the output itself for fluent method calls