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

DataItemExtractor

interface DataItemExtractor : JsonPathExtractable<JsonPath.Component.Key>

Defines common read methods for getting or extracting common data types from a Map-like object containing DataItems

Inheritors

Functions

Link copied to clipboard
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

Link copied to clipboard
open fun extractBoolean(jsonPath: JsonPath<JsonPath.Component.Key>): Boolean?

Extracts a nested Boolean according to the given jsonPath.

Link copied to clipboard
open fun extractDataList(jsonPath: JsonPath<JsonPath.Component.Key>): DataList?

Extracts a nested DataList according to the given jsonPath.

Link copied to clipboard
open fun extractDataObject(jsonPath: JsonPath<JsonPath.Component.Key>): DataObject?

Extracts a nested DataObject according to the given jsonPath.

Link copied to clipboard
open fun extractDouble(jsonPath: JsonPath<JsonPath.Component.Key>): Double?

Extracts a nested Double according to the given jsonPath.

Link copied to clipboard
open fun extractInt(jsonPath: JsonPath<JsonPath.Component.Key>): Int?

Extracts a nested Int according to the given jsonPath.

Link copied to clipboard
open fun extractLong(jsonPath: JsonPath<JsonPath.Component.Key>): Long?

Extracts a nested Long according to the given jsonPath.

Link copied to clipboard
open fun extractString(jsonPath: JsonPath<JsonPath.Component.Key>): String?

Extracts a nested String according to the given jsonPath.

Link copied to clipboard
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

Link copied to clipboard
open fun getBoolean(key: String): Boolean?

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

Link copied to clipboard
open fun getDataList(key: String): DataList?

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

Link copied to clipboard
open fun getDataObject(key: String): DataObject?

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

Link copied to clipboard
open fun getDouble(key: String): Double?

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

Link copied to clipboard
open fun getInt(key: String): Int?

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

Link copied to clipboard
open fun getLong(key: String): Long?

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

Link copied to clipboard
open fun getString(key: String): String?

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