1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/*
* Copyright 2017-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
@file:Suppress("RedundantVisibilityModifier")
package kotlinx.serialization.modules
import kotlinx.serialization.*
import kotlin.reflect.*
/**
* [SerializersModuleCollector] can introspect and accumulate content of any [SerializersModule] via [SerializersModule.dumpTo],
* using a visitor-like pattern: [contextual] and [polymorphic] functions are invoked for each registered serializer.
*
* ### Not stable for inheritance
*
* `SerializersModuleCollector` interface is not stable for inheritance in 3rd party libraries, as new methods
* might be added to this interface or contracts of the existing methods can be changed.
*/
@ExperimentalSerializationApi
public interface SerializersModuleCollector {
/**
* Accept a serializer, associated with [kClass] for contextual serialization.
*/
public fun <T : Any> contextual(kClass: KClass<T>, serializer: KSerializer<T>): Unit =
contextual(kClass) { serializer }
/**
* Accept a provider, associated with generic [kClass] for contextual serialization.
*/
public fun <T : Any> contextual(
kClass: KClass<T>,
provider: (typeArgumentsSerializers: List<KSerializer<*>>) -> KSerializer<*>
)
/**
* Accept a serializer, associated with [actualClass] for polymorphic serialization.
*/
public fun <Base : Any, Sub : Base> polymorphic(
baseClass: KClass<Base>,
actualClass: KClass<Sub>,
actualSerializer: KSerializer<Sub>
)
/**
* Accept a default serializer provider, associated with the [baseClass] for polymorphic serialization.
*
* This will not affect deserialization.
*
* @see SerializersModuleBuilder.polymorphicDefaultSerializer
* @see PolymorphicModuleBuilder.defaultSerializer
*/
@ExperimentalSerializationApi
public fun <Base : Any> polymorphicDefaultSerializer(
baseClass: KClass<Base>,
defaultSerializerProvider: (value: Base) -> SerializationStrategy<Base>?
)
/**
* Accept a default deserializer provider, associated with the [baseClass] for polymorphic deserialization.
*
* This will not affect serialization.
*
* @see SerializersModuleBuilder.polymorphicDefaultDeserializer
* @see PolymorphicModuleBuilder.defaultDeserializer
*/
@ExperimentalSerializationApi
public fun <Base : Any> polymorphicDefaultDeserializer(
baseClass: KClass<Base>,
defaultDeserializerProvider: (className: String?) -> DeserializationStrategy<out Base>?
)
/**
* Accept a default deserializer provider, associated with the [baseClass] for polymorphic deserialization.
*
* This will not affect serialization.
*
* @see SerializersModuleBuilder.polymorphicDefaultDeserializer
* @see PolymorphicModuleBuilder.defaultDeserializer
*/
// TODO: deprecate in 1.4
public fun <Base : Any> polymorphicDefault(
baseClass: KClass<Base>,
defaultDeserializerProvider: (className: String?) -> DeserializationStrategy<out Base>?
) {
polymorphicDefaultDeserializer(baseClass, defaultDeserializerProvider)
}
}
|
