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

DataList

class DataList : Iterable<DataItem> , DataItemConvertible, JsonPathExtractable<JsonPath.Component.Index>

The DataList represents a list 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 DataList are immutable. When requiring updates, the copy method is available to use, which is prepopulate a Builder with the existing set of DataItems

Indexing starts at 0 as with standard Java lists.

This class will serialize to a JSON array - [ ... ] - when calling toString.

See also

Types

class Builder @JvmOverloads constructor(copy: DataList = EMPTY_LIST)

object Companion

Properties

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

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 DataList.asParcelable(): ParcelableDataItem

Returns a ParcelableDataItem that wraps the DataItem.

fun buildPath(path: JsonListPath, item: DataItem): DataList

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

fun buildUpon(): DataList.Builder

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

fun contains(value: DataItem): Boolean

Checks for the existence of the given value in the DataList

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

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

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

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

Extracts a nested DataItem according to the given jsonPath.

open fun <T> extract(jsonPath: JsonPath<JsonPath.Component.Index>, 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.Index>): Boolean?

Extracts a nested Boolean according to the given jsonPath.

extractDataList

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

Extracts a nested DataList according to the given jsonPath.

extractDataObject

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

Extracts a nested DataObject according to the given jsonPath.

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

Extracts a nested Double according to the given jsonPath.

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

Extracts a nested Int according to the given jsonPath.

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

Extracts a nested Long according to the given jsonPath.

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

Extracts a nested String according to the given jsonPath.

fun get(index: Int): DataItem?

Gets the DataItem at the given index.

fun <T> get(index: Int, converter: DataItemConverter<T>): T?

Gets the DataItem at the given index, and attempts to convert it into the type T using the provided DataItemConverter.

fun getBoolean(index: Int): Boolean?

Gets the Boolean entry at the given index if it exists and the value can be correctly coerced to an Boolean.

fun getDataList(index: Int): DataList?

Gets the DataList entry at the given index if it exists and the value is a DataList.

fun getDataObject(index: Int): DataObject?

Gets the DataObject entry at the given index if it exists and the value is a DataObject.

fun getDouble(index: Int): Double?

Gets the Double entry at the given index if it exists and the value is a Double, or a Number that can be coerced to an Double.

fun getInt(index: Int): Int?

Gets the Int entry at the given index if it exists and the value is an Int, or a Number that can be coerced to an Int.

fun getLong(index: Int): Long?

Gets the Long entry at the given index if it exists and the value is a Long, or a Number that can be coerced to an Long.

fun getString(index: Int): String?

Gets the String entry at the given index if the underlying value is a String.

open override fun hashCode(): Int

open operator override fun iterator(): Iterator<DataItem>

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

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

open override fun toString(): String