ClassDiscriminatorMode
public static class ClassDiscriminatorMode
Defines which classes and objects should have their serial name included in the SavedState as a class discriminator.
The class discriminator is a SavedState field added by kotlinx.serialization with a key (type by default), and the class's serial name as a value (fully qualified name by default).
Class discriminator is important for serializing and deserializing polymorphic class hierarchies. Default ClassDiscriminatorMode.POLYMORPHIC mode adds discriminator only to polymorphic classes.
| See also | |
|---|---|
classDiscriminatorMode |
Summary
Constants |
|
|---|---|
static final int |
ALL_OBJECTS = 1Includes class discriminators whenever possible. |
static final int |
POLYMORPHIC = 2Includes class discriminators for polymorphic classes. |
Public fields |
|
|---|---|
static @NonNull ClassDiscriminatorMode |
Constants
ALL_OBJECTS
public static final int ALL_OBJECTS = 1
Includes class discriminators whenever possible.
Given that class discriminator is added as a SavedState field, adding class discriminator is possible when the resulting SavedState is an object — i.e., for Kotlin classes, objects, and interfaces. More specifically, discriminator is added to the output of serializers which descriptors have a kotlinx.serialization.descriptors.SerialKind of either kotlinx.serialization.descriptors.StructureKind.CLASS or kotlinx.serialization.descriptors.StructureKind.OBJECT.
POLYMORPHIC
public static final int POLYMORPHIC = 2
Includes class discriminators for polymorphic classes.
Sealed classes, abstract classes, and interfaces are polymorphic classes by definition. Open classes can be polymorphic if they are serializable with kotlinx.serialization.PolymorphicSerializer and properly registered in the kotlinx.serialization.modules.SerializersModule. See kotlinx.serialization polymorphism guide for details.