core/com.tealium.prism.core.api.persistence/DataStore

DataStore

interface DataStore : ReadableDataStore, Iterable<Map.Entry<String, DataItem>>

Generic data storage for storing and retrieving DataItem objects.

Implementations are not guaranteed to be persistent. For instance, in cases where there may be insufficient storage space on the device, or other reasons such as write permissions etc.

Stored data requires an Expiry to be provided when storing, and expired data will not be included in any retrieval operations; that is, expired data won't be returned by get or getAll but it will also not be included in any aggregate methods such as keys or count

See also

Types

interface Editor : ReadableDataStore, AutoCloseable

Enables editing multiple entries in the module storage in a transactional way.

Properties

abstract val onDataRemoved: Observable<List<String>>

Flow of keys from this DataStore that have been removed.

abstract val onDataUpdated: Observable<DataObject>

Flow of key-value pairs from this DataStore that have been updated.

Functions

abstract fun count(): Int

Returns the number of entries in this DataStore

abstract fun edit(): DataStore.Editor

Returns an Editor able to mutate the data in this ModuleStorage

open override fun extract(jsonPath: JsonPath<JsonPath.Component.Key>): DataItem?

Extracts a nested DataItem according to the given jsonPath.

open fun <T> extract(jsonPath: JsonPath<JsonPath.Component.Key>, converter: DataItemConverter<T>): T?

Extracts a nested DataItem according to the given jsonPath, and attempts to convert it to the type T using the given converter

open fun extractBoolean(jsonPath: JsonPath<JsonPath.Component.Key>): Boolean?

Extracts a nested Boolean according to the given jsonPath.

extractDataList

open fun extractDataList(jsonPath: JsonPath<JsonPath.Component.Key>): DataList?

Extracts a nested DataList according to the given jsonPath.

extractDataObject

open fun extractDataObject(jsonPath: JsonPath<JsonPath.Component.Key>): DataObject?

Extracts a nested DataObject according to the given jsonPath.

open fun extractDouble(jsonPath: JsonPath<JsonPath.Component.Key>): Double?

Extracts a nested Double according to the given jsonPath.

open fun extractInt(jsonPath: JsonPath<JsonPath.Component.Key>): Int?

Extracts a nested Int according to the given jsonPath.

open fun extractLong(jsonPath: JsonPath<JsonPath.Component.Key>): Long?

Extracts a nested Long according to the given jsonPath.

open fun extractString(jsonPath: JsonPath<JsonPath.Component.Key>): String?

Extracts a nested String according to the given jsonPath.

abstract fun get(key: String): DataItem?

Gets the DataItem stored at the given key if there is one

open fun <T> get(key: String, converter: DataItemConverter<T>): T?

Gets the DataItem stored at the given key if there is one, and uses the given converter to translate it into an instance of type T

abstract fun getAll(): DataObject

Gets the entire DataObject containing all data stored.

open fun getBoolean(key: String): Boolean?

Gets the Boolean stored at the given key if there is one

open fun getDataList(key: String): DataList?

Gets the DataList stored at the given key if there is one

open fun getDataObject(key: String): DataObject?

Gets the DataObject stored at the given key if there is one

open fun getDouble(key: String): Double?

Gets the Double stored at the given key if there is one

open fun getInt(key: String): Int?

Gets the Int stored at the given key if there is one

open fun getLong(key: String): Long?

Gets the Long stored at the given key if there is one

open fun getString(key: String): String?

Gets the String stored at the given key if there is one

abstract operator fun iterator(): Iterator<Map.Entry<String, DataItem>>

abstract fun keys(): List<String>

Returns all keys stored in this DataStore

fun <T> Iterable<Observable<T>>.merge(): Observable<T>

Convenience method for merging a Iterable group of Observables of the same type.