io.atomix.utils.serializer

Class Namespace.Builder

java.lang.Object

io.atomix.utils.serializer.Namespace.Builder

Enclosing class:

Namespace

public static final class Namespace.Builder
extends java.lang.Object

KryoNamespace builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Namespace	build() Builds a Namespace instance.
Namespace	build(java.lang.String friendlyName) Builds a Namespace instance.
Namespace.Builder	nextId(int id) Sets the next Kryo registration Id for following register entries.
Namespace.Builder	register(java.lang.Class<?>... expectedTypes) Registers classes to be serialized using Kryo default serializer.
Namespace.Builder	register(Namespace ns) Registers all the class registered to given KryoNamespace.
Namespace.Builder	register(com.esotericsoftware.kryo.Serializer<?> serializer, java.lang.Class<?>... classes) Registers serializer for the given set of classes.
Namespace.Builder	setClassLoader(java.lang.ClassLoader classLoader) Sets the namespace class loader.
Namespace.Builder	setCompatible(boolean compatible) Sets whether backwards/forwards compatible versioned serialization is enabled.
Namespace.Builder	setRegistrationRequired(boolean registrationRequired) Sets the registrationRequired flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public Namespace build()

Builds a Namespace instance.

Returns:

KryoNamespace

build

public Namespace build(java.lang.String friendlyName)

Builds a Namespace instance.

Parameters:

friendlyName - friendly name for the namespace

Returns:

KryoNamespace

nextId

public Namespace.Builder nextId(int id)

Sets the next Kryo registration Id for following register entries.

Parameters:

id - Kryo registration Id

Returns:

this

See Also:

Kryo.register(Class, Serializer, int)

register

public Namespace.Builder register(java.lang.Class<?>... expectedTypes)

Registers classes to be serialized using Kryo default serializer.

Parameters:

expectedTypes - list of classes

Returns:

this

register

public Namespace.Builder register(com.esotericsoftware.kryo.Serializer<?> serializer,
                                  java.lang.Class<?>... classes)

Registers serializer for the given set of classes.

When multiple classes are registered with an explicitly provided serializer, the namespace guarantees all instances will be serialized with the same type ID.

Parameters:

classes - list of classes to register

serializer - serializer to use for the class

Returns:

this

register

public Namespace.Builder register(Namespace ns)

Registers all the class registered to given KryoNamespace.

Parameters:

ns - KryoNamespace

Returns:

this

setClassLoader

public Namespace.Builder setClassLoader(java.lang.ClassLoader classLoader)

Sets the namespace class loader.

Parameters:

classLoader - the namespace class loader

Returns:

the namespace builder

setCompatible

public Namespace.Builder setCompatible(boolean compatible)

Sets whether backwards/forwards compatible versioned serialization is enabled.

When compatible serialization is enabled, the CompatibleFieldSerializer will be set as the default serializer for types that do not otherwise explicitly specify a serializer.

Parameters:

compatible - whether versioned serialization is enabled

Returns:

this

setRegistrationRequired

public Namespace.Builder setRegistrationRequired(boolean registrationRequired)

Sets the registrationRequired flag.

Parameters:

registrationRequired - Kryo's registrationRequired flag

Returns:

this

See Also:

Kryo.setRegistrationRequired(boolean)