Serializer.Options (Apache Polygene™ (Java Edition) SDK 3.0.0)

Enclosing interface:

Serializer
```
public static interface Serializer.Options
```
State serializer options. Use builder() to create new instances. All options provided by the builder are safe to use with all serialization extensions. Serialization extensions might provide more options, see option(String) and the respective extension documentation.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Serializer.Options.Builder
Builder for Serializer.Options.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Serializer.Options.Builder` Builder for `Serializer.Options`.

Field Summary

Fields
Modifier and Type	Field and Description
`static Serializer.Options`	`ALL_TYPE_INFO` State serializer options with both `rootTypeInfo()` and `nestedTypeInfo()` set to true.
`static Serializer.Options`	`DEFAULT` Default state serializer options.
`static Serializer.Options`	`NO_TYPE_INFO` State serializer options with both `rootTypeInfo()` and `nestedTypeInfo()` set to false.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Serializer.Options.Builder`	`builder()` Create a new builder of `Serializer.Options`
`boolean`	`nestedTypeInfo()` Include type information in the serialized form of nested values.
`String`	`option(String option)` Query for an option's value.
`boolean`	`rootTypeInfo()`

- Field Detail
  - DEFAULT
```
static final Serializer.Options DEFAULT
```
    Default state serializer options. rootTypeInfo() set to false. nestedTypeInfo() set to true.
  - NO_TYPE_INFO
```
static final Serializer.Options NO_TYPE_INFO
```
    State serializer options with both rootTypeInfo() and nestedTypeInfo() set to false.
  - ALL_TYPE_INFO
```
static final Serializer.Options ALL_TYPE_INFO
```
    State serializer options with both rootTypeInfo() and nestedTypeInfo() set to true.
- Method Detail
  - rootTypeInfo
```
boolean rootTypeInfo()
```
  - nestedTypeInfo
```
boolean nestedTypeInfo()
```
    Include type information in the serialized form of nested values. Boolean flag to include type information in the serialized form of nested values types. Each serialization extension is free to chose how to represent this type information. This is enabled by default to allow for polymorphic deserialization. Let's say you have a type hierarchy of values as follows ; interface Parent { Property<String> something(); } interface Child1 { Property<Long> number(); } interface Child2 { Property<Duration> duration(); } and want to serialize and deserialize a set of values like this one ; interface MyValue { Property<Parent> polymorphicValue(); } that is a view of a value composite that also has the following fragments ; interface MyValueWithNumber { Property<Child1> polymorphicValue(); } interface MyValueWithDuration { Property<Child2> polymorphicValue(); } when deserializing, the Deserializer needs a way to know which specialization type to use to deserialize the value state, Child1 or Child2 in our example. If the deserializer can't know it use the type information from the ValueType provided at deserialization time. Disable it using Serializer.Options.Builder.withoutNestedTypeInfo() if you are sure you don't need this.
    
    Returns:
    
    true if type information must be included in the serialized form of nested values, false otherwise
  - option
```
String option(String option)
```
    Query for an option's value.
    
    Parameters:
    
    option - the option
    
    Returns:
    
    the option's value, null if absent
  - builder
```
static Serializer.Options.Builder builder()
```
    Create a new builder of Serializer.Options
    
    Returns:
    
    a new builder

Interface Serializer.Options

Nested Class Summary

Field Summary

Method Summary

Field Detail

DEFAULT

NO_TYPE_INFO

ALL_TYPE_INFO

Method Detail

rootTypeInfo

nestedTypeInfo

option

builder