commonMain.kotlinx.serialization.modules.SerializersModuleCollector.kt Maven / Gradle / Ivy

Go to download
/*
 * 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  contextual(kClass: KClass, serializer: KSerializer): Unit =
        contextual(kClass) { serializer }


    /**
     * Accept a provider, associated with generic [kClass] for contextual serialization.
     */
    public fun  contextual(
        kClass: KClass,
        provider: (typeArgumentsSerializers: List>) -> KSerializer<*>
    )

    /**
     * Accept a serializer, associated with [actualClass] for polymorphic serialization.
     */
    public fun  polymorphic(
        baseClass: KClass,
        actualClass: KClass_{,
        actualSerializer: KSerializer_{)

    /**
     * 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  polymorphicDefaultSerializer(
        baseClass: KClass,
        defaultSerializerProvider: (value: Base) -> SerializationStrategy?
    )

    /**
     * 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  polymorphicDefaultDeserializer(
        baseClass: KClass,
        defaultDeserializerProvider: (className: String?) -> DeserializationStrategy?
    )

    /**
     * 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  polymorphicDefault(
        baseClass: KClass,
        defaultDeserializerProvider: (className: String?) -> DeserializationStrategy?
    ) {
        polymorphicDefaultDeserializer(baseClass, defaultDeserializerProvider)
    }
}}}