core/com.tealium.prism.core.api.data/DataObject/Builder

Builder

class Builder @JvmOverloads constructor(copy: DataObject = EMPTY_OBJECT) : DataItemExtractor

Constructors

constructor(copy: DataObject = EMPTY_OBJECT)

Functions

fun build(): DataObject

Creates an immutable DataObject using the values added to the builder.

fun buildPath(path: JsonObjectPath, item: DataItem): DataObject.Builder

Builds the necessary path according to the given path in order to store the given item.

fun clear(): DataObject.Builder

Clears all entries in the Builder.

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.

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

open operator override fun get(key: String): DataItem?

Gets the DataItem at the given key, if there is one.

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

fun put(key: String, value: DataItem): DataObject.Builder

fun put(key: String, value: Boolean): DataObject.Builder

fun put(key: String, value: Double): DataObject.Builder

fun put(key: String, value: Int): DataObject.Builder

fun put(key: String, value: Long): DataObject.Builder

fun put(key: String, value: String): DataObject.Builder

Adds the provided value into this DataObject.Builder, overwriting the existing item at that key if it already exists.

fun put(key: String, value: DataItemConvertible): DataObject.Builder

Adds a DataItemConvertible object to the DataObject. The

fun putAll(dataObject: DataObject): DataObject.Builder

Adds all entries from the provided dataObject into this DataObject.Builder, overwriting any keys that already exist.

fun putAny(key: String, any: Any?): DataObject.Builder

Unsafe shortcut to put any object into the DataObject. The any will attempt to be converted to a supported type. If no supported type is available, then an UnsupportedDataItemException will be thrown.

fun putAnyOrNull(key: String, any: Any?): DataObject.Builder

Attempts to put any object into the DataObject. The any will attempt to be converted to a supported type. If no supported type is available, then DataItem.NULL will be instead.

fun putNull(key: String): DataObject.Builder

Adds a DataItem.NULL object to the DataObject.

fun remove(key: String): DataObject.Builder

Removes the entry currently stored at the current key. If the key does not exist, then this is a no-operation.