commonMain.com.algolia.search.model.Attribute.kt Maven / Gradle / Ivy

Go to download
package com.algolia.search.model

import com.algolia.search.exception.EmptyStringException
import com.algolia.search.helper.toAttribute
import com.algolia.search.model.internal.Raw
import kotlinx.serialization.KSerializer
import kotlinx.serialization.Serializable
import kotlinx.serialization.builtins.serializer
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder

/**
 * An attribute is a key in the json definition of a record.
 * Example:
 *
 * ```
 * {
 *  "color": "red"
 * }
 * ```
 *
 * This record has an attribute "color", and its value is "red".
 */
@Serializable(Attribute.Companion::class)
public data class Attribute(override val raw: String) : Raw {

    init {
        if (raw.isBlank()) throw EmptyStringException("Attribute")
    }

    override fun toString(): String {
        return raw
    }

    public companion object : KSerializer {

        private val serializer = String.serializer()

        override val descriptor: SerialDescriptor = serializer.descriptor

        override fun serialize(encoder: Encoder, value: Attribute) {
            String.serializer().serialize(encoder, value.raw)
        }

        override fun deserialize(decoder: Decoder): Attribute {
            return serializer.deserialize(decoder).toAttribute()
        }
    }
}