Package io.permazen.core.util

Class XMLObjectSerializer.OutputOptions.Builder

java.lang.Object

io.permazen.core.util.XMLObjectSerializer.OutputOptions.Builder

All Implemented Interfaces:

Cloneable

Enclosing class:

XMLObjectSerializer.OutputOptions

public static final class XMLObjectSerializer.OutputOptions.Builder
extends Object
implements Cloneable

Builder for XMLObjectSerializer.OutputOptions.

Method Summary

Modifier and Type	Method	Description
XMLObjectSerializer.OutputOptions	build()	Create a new XMLObjectSerializer.OutputOptions from this instance.
XMLObjectSerializer.OutputOptions.Builder	clone()	Clone this instance.
XMLObjectSerializer.OutputOptions.Builder	elementsAsNames(boolean elementsAsNames)	Configure whether to output XML element names that are based on the corresponding object or field name.
XMLObjectSerializer.OutputOptions.Builder	includeStorageIds(boolean includeStorageIds)	Configure whether to include storage ID's in the output.
XMLObjectSerializer.OutputOptions.Builder	objectGenerator(Function<? super Transaction,? extends Stream<? extends ObjId>> objectGenerator)	Configure a custom function that streams the objects to include in the output (identified by ObjId).
XMLObjectSerializer.OutputOptions.Builder	prettyPrint(boolean prettyPrint)	Configure whether to pretty-print the XML, i.e., indent and include storage ID comments.
XMLObjectSerializer.OutputOptions.Builder	schemaGenerator(Function<? super Transaction,? extends Stream<? extends SchemaModel>> schemaGenerator)	Configure a custom function that streams the SchemaModels to include in the output.

Methods inherited from class java.lang.Object

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

Method Details

schemaGenerator

public XMLObjectSerializer.OutputOptions.Builder schemaGenerator(Function<? super Transaction,? extends Stream<? extends SchemaModel>> schemaGenerator)

Configure a custom function that streams the SchemaModels to include in the output.

The generated SchemaModels should always include storage ID's, so that the includeStorageIds option can decide whether they are expressed in the output.

Parameters:

schemaGenerator - custom SchemaModel streaming function, or null to stream all schemas in the database

objectGenerator

public XMLObjectSerializer.OutputOptions.Builder objectGenerator(Function<? super Transaction,? extends Stream<? extends ObjId>> objectGenerator)

Configure a custom function that streams the objects to include in the output (identified by ObjId).

Returns:

custom ObjId streaming function, or null to stream all objects in the database

elementsAsNames

public XMLObjectSerializer.OutputOptions.Builder elementsAsNames(boolean elementsAsNames)

Configure whether to output XML element names that are based on the corresponding object or field name.

The default value is true.

Parameters:

elementsAsNames - whether to use custom XML element names

Returns:

this instance

includeStorageIds

public XMLObjectSerializer.OutputOptions.Builder includeStorageIds(boolean includeStorageIds)

Configure whether to include storage ID's in the output.

The default value is false.

Parameters:

includeStorageIds - whether to include storage ID's

Returns:

this instance

prettyPrint

public XMLObjectSerializer.OutputOptions.Builder prettyPrint(boolean prettyPrint)

Configure whether to pretty-print the XML, i.e., indent and include storage ID comments.

The default value is true.

Parameters:

prettyPrint - whether to pretty-print

Returns:

this instance

build

public XMLObjectSerializer.OutputOptions build()

Create a new XMLObjectSerializer.OutputOptions from this instance.

Returns:

new output config

clone

public XMLObjectSerializer.OutputOptions.Builder clone()

Clone this instance.

Overrides:

clone in class Object

Returns:

clone of this instance