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

Editor

interface Editor : ReadableDataStore, AutoCloseable

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

All updating/reading methods will throw EditorClosedException if the Editor has already been closed.

Types

EditorClosedException

class EditorClosedException(message: String) : TealiumException

This exception signifies that the Editor was interacted with after it has been closed.

Functions

clear

abstract fun clear(): DataStore.Editor

Clears all entries from storage before then adding any any key-value pairs added to this editor.

abstract fun close()

commit

abstract fun commit()

Writes the updates to disk.

count

abstract fun count(): Int

Returns the number of entries in this DataStore

extract

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

extractBoolean

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.

extractDouble

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

Extracts a nested Double according to the given jsonPath.

extractInt

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

Extracts a nested Int according to the given jsonPath.

extractLong

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

Extracts a nested Long according to the given jsonPath.

extractString

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

Extracts a nested String according to the given jsonPath.

get

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

getAll

abstract fun getAll(): DataObject

Gets the entire DataObject containing all data stored.

getBoolean

open fun getBoolean(key: String): Boolean?

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

getDataList

open fun getDataList(key: String): DataList?

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

getDataObject

open fun getDataObject(key: String): DataObject?

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

getDouble

open fun getDouble(key: String): Double?

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

getInt

open fun getInt(key: String): Int?

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

getLong

open fun getLong(key: String): Long?

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

getString

open fun getString(key: String): String?

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

keys

abstract fun keys(): List<String>

Returns all keys stored in this DataStore

put

abstract fun put(key: String, value: DataItem, expiry: Expiry): DataStore.Editor

open fun put(key: String, value: DataItemConvertible, expiry: Expiry): DataStore.Editor

open fun put(key: String, value: DataList, expiry: Expiry): DataStore.Editor

open fun put(key: String, value: DataObject, expiry: Expiry): DataStore.Editor

open fun put(key: String, value: Boolean, expiry: Expiry): DataStore.Editor

open fun put(key: String, value: Double, expiry: Expiry): DataStore.Editor

open fun put(key: String, value: Int, expiry: Expiry): DataStore.Editor

open fun put(key: String, value: Long, expiry: Expiry): DataStore.Editor

open fun put(key: String, value: String, expiry: Expiry): DataStore.Editor

Adds a single key-value pair to the storage

putAll

abstract fun putAll(dataObject: DataObject, expiry: Expiry): DataStore.Editor

Adds all key-value pairs from the dataObject into the storage.

remove

abstract fun remove(key: String): DataStore.Editor

Removes and individual key from storage

abstract fun remove(keys: List<String>): DataStore.Editor

Removes multiple keys from storage