org.apache.polygene.api.serialization

Class Serializer.Options.Builder

java.lang.Object

org.apache.polygene.api.serialization.Serializer.Options.Builder

Enclosing interface:

Serializer.Options

public static final class Serializer.Options.Builder
extends Object

Builder for Serializer.Options. This builder is mutable, built instances are not.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Serializer.Options	build() Build the options.
Serializer.Options.Builder	withNestedTypeInfo() Include type information in the serialized form of nested values.
Serializer.Options.Builder	withOption(String option, String value) Set extension specific option.
Serializer.Options.Builder	withoutNestedTypeInfo() Do not include type information in the serialized form of nested values.
Serializer.Options.Builder	withoutOption(String option) Remove extension specific option.
Serializer.Options.Builder	withoutRootTypeInfo()
Serializer.Options.Builder	withRootTypeInfo()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withRootTypeInfo

public Serializer.Options.Builder withRootTypeInfo()

withoutRootTypeInfo

public Serializer.Options.Builder withoutRootTypeInfo()

withNestedTypeInfo

public Serializer.Options.Builder withNestedTypeInfo()

Include type information in the serialized form of nested values.

Returns:

this builder

withoutNestedTypeInfo

public Serializer.Options.Builder withoutNestedTypeInfo()

Do not include type information in the serialized form of nested values. WARNING Without this, Deserializers will use the provided ValueType for instantiation potentially breaking polymorphism, see Serializer.Options.nestedTypeInfo().

Returns:

this builder

See Also:

withNestedTypeInfo()

withOption

public Serializer.Options.Builder withOption(String option,
                                             String value)

Set extension specific option.

Parameters:

option - the option to add

value - it's value

Returns:

this builder

withoutOption

public Serializer.Options.Builder withoutOption(String option)

Remove extension specific option.

Parameters:

option - the option to remove

Returns:

this builder

build

public Serializer.Options build()

Build the options.

Returns:

a new immutable instance of Serializer.Options.