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

DataObject

class DataObject : Iterable<Map.Entry<String, DataItem>> , DataItemConvertible, DataItemExtractor

The DataObject represents a map of restricted data types which are wrappable by DataItem, to ensure that all data passed to the SDK can be used correctly and without unexpected behaviours when converting to Strings.

Instances of DataObject are immutable. When requiring updates, the copy method is available to use, which is prepopulate a Builder with the existing set of DataItems

This class will serialize to a JSON object - { ... } - when calling toString.

See also

Types

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

object Companion

object Converter : DataItemConverter<DataObject>

Properties

Returns the number of top level entries stored in this DataObject.

Functions

open override fun asDataItem(): DataItem

Should return an instance of a DataItem that represents all required properties of the implementing class, such that it could be:

fun DataObject.asParcelable(): ParcelableDataItem

Returns a ParcelableDataItem that wraps the DataItem.

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

Takes a copy of this DataObject and builds the necessary path according to the given path in order to store the given item.

fun buildUpon(): DataObject.Builder

Convenience method to create a new Builder containing all the values in this DataObject

inline fun copy(block: DataObject.Builder.() -> Unit = {}): DataObject

Copies the existing DataObject into a new Builder instance that can be used to add/remove entries and create a new instance of the DataObject

open operator override fun equals(other: Any?): Boolean

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 override fun get(key: String): DataItem?

Gets the DataItem stored at the given key if it exists regardless of it's underlying type.

fun getAll(): Map<String, DataItem>

Returns all entries stored in the DataObject

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

open override fun hashCode(): Int

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

Returns the Iterator in order to iterate over the collection.

inline fun <T> DataObject.mapValues(transform: (DataItem) -> T): Map<String, T>

Maps the Map.Entry.value component only, keeping the Map.Entry.key the same.

mapValuesNotNull

inline fun <T> DataObject.mapValuesNotNull(transform: (DataItem) -> T?): Map<String, T>

Maps the Map.Entry.value component only, keeping the Map.Entry.key the same.

fun merge(other: DataObject, depth: Int = Int.MAX_VALUE): DataObject

Deep merges two DataObjects together, returning a new DataObject containing the merged data.

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

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

operator fun DataObject.plus(other: DataObject): DataObject

Merges two DataObject objects together.

open override fun toString(): String