commonMain.com.algolia.search.model.dictionary.Dictionary.kt Maven / Gradle / Ivy

Go to download
package com.algolia.search.model.dictionary

import com.algolia.search.helper.internal.encodeUTF8
import com.algolia.search.model.dictionary.DictionaryEntry.Compound
import com.algolia.search.model.dictionary.DictionaryEntry.Plural
import com.algolia.search.model.dictionary.DictionaryEntry.Stopword
import com.algolia.search.model.internal.Raw
import com.algolia.search.serialize.internal.Key
import com.algolia.search.serialize.internal.Route
import kotlinx.serialization.Serializable

/**
 * Represents a linguistic resources provided by Algolia.
 */
@Serializable
public sealed class Dictionary(
    override val raw: String,
) : Raw {

    @Serializable
    public object Plurals : Dictionary(Key.Plurals)

    @Serializable
    public object Stopwords : Dictionary(Key.Stopwords)

    @Serializable
    public object Compounds : Dictionary(Key.Compounds)

    private fun encode(): String {
        return raw.encodeUTF8()
    }

    internal fun toPath(suffix: String? = null): String {
        return "${Route.Dictionaries}/${encode()}" + (suffix ?: "")
    }

    override fun toString(): String {
        return raw
    }
}