settings-core/io.github.mlmgames.settings.core.fields/BaseMapField

BaseMapField

abstract class BaseMapField<T, K, V>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Map<K, V>, setter: (T, Map<K, V>) -> T, serializer: KSerializer<Map<K, V>>, json: Json = SerializedField.DefaultJson) : SettingField<T, Map<K, V>>

Base class for map fields that stores maps as JSON strings.

Inheritors

StringBooleanMapField

Constructors

BaseMapField

constructor(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<K, V>, setter: (T, Map<K, V>) -> T, serializer: KSerializer<Map<K, V>>, json: Json = SerializedField.DefaultJson)

Properties

keyName

open override val keyName: String

DataStore key name

Functions

get

open override fun get(model: T): Map<K, V>

Get value from model

read

open override fun read(prefs: Preferences): Map<K, V>?

Read from preferences

set

open override fun set(model: T, value: Map<K, V>): T

Set value in model (returns new model)

write

open override fun write(prefs: MutablePreferences, value: Map<K, V>)

Write to preferences