Package io.permazen.core.util

Class XMLObjectSerializer.OutputOptions

java.lang.Object

io.permazen.core.util.XMLObjectSerializer.OutputOptions

Enclosing class:

XMLObjectSerializer

public static final class XMLObjectSerializer.OutputOptions
extends Object

Options for the output XML format produced by XMLObjectSerializer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	XMLObjectSerializer.OutputOptions.Builder	Builder for XMLObjectSerializer.OutputOptions.

Method Summary

Modifier and Type	Method	Description
static XMLObjectSerializer.OutputOptions.Builder	builder()
XMLObjectSerializer.OutputOptions.Builder	copy()	Create a XMLObjectSerializer.OutputOptions.Builder that is pre-configured as a copy of this instance.
boolean	isElementsAsNames()	Determine whether to output XML element names that are based on the corresponding object or field name.
boolean	isIncludeStorageIds()	Determine whether to include storage ID's in the output.
boolean	isPrettyPrint()	Determine whether to pretty-print the XML, i.e., indent and include storage ID comments.
Function<? super Transaction,? extends Stream<? extends ObjId>>	objectGenerator()	Get the function that streams the objects to include in the output (identified by ObjId).
Function<? super Transaction,? extends Stream<? extends SchemaModel>>	schemaGenerator()	Get the function that streams the SchemaModels to include in the output.

Methods inherited from class java.lang.Object

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

Method Details

schemaGenerator

public Function<? super Transaction,? extends Stream<? extends SchemaModel>> schemaGenerator()

Get the function that streams the SchemaModels to include in the output.

Returns:

SchemaModel streaming function, never null

objectGenerator

public Function<? super Transaction,? extends Stream<? extends ObjId>> objectGenerator()

Get the function that streams the objects to include in the output (identified by ObjId).

Returns:

ObjId streaming function, never null

isElementsAsNames

public boolean isElementsAsNames()

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

Returns:

whether to use custom XML element names

isIncludeStorageIds

public boolean isIncludeStorageIds()

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

Returns:

whether to include storage ID's

isPrettyPrint

public boolean isPrettyPrint()

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

Returns:

whether to pretty-print

builder

public static XMLObjectSerializer.OutputOptions.Builder builder()

copy

public XMLObjectSerializer.OutputOptions.Builder copy()

Create a XMLObjectSerializer.OutputOptions.Builder that is pre-configured as a copy of this instance.

Returns:

new pre-configured builder