platform_framework_api_configuration_api/com.tomtom.ivi.platform.framework.api.configuration.api

Package-level declarations

The API of TomTom Digital Cockpit's configuration framework.

Types

data class BooleanDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a Boolean value type.

BooleanDynamicConfigurationValue

typealias BooleanDynamicConfigurationValue = DynamicConfigurationValue<Boolean>

A representation of a configuration value of type Boolean with update information.

BooleanListDynamicConfigurationKey

data class BooleanListDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a List<Boolean> value type.

BooleanListDynamicConfigurationValue

typealias BooleanListDynamicConfigurationValue = DynamicConfigurationValue<List<Boolean>>

A representation of a configuration value of type List<Boolean> with update information.

BooleanListStaticConfigurationKey

data class BooleanListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Boolean> value type.

BooleanStaticConfigurationKey

data class BooleanStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Boolean value type.

ComposableDynamicConfigurationProvider

interface ComposableDynamicConfigurationProvider

A dynamic configuration provider that can be composed of other providers.

ComposableStaticConfigurationProvider

interface ComposableStaticConfigurationProvider

A static configuration provider that can be composed of other providers.

ConfigurationUpdateStrategy

enum ConfigurationUpdateStrategy : Enum<ConfigurationUpdateStrategy>

A strategy that specifies what happens to the existing configuration value after changing the default value.

DoubleDynamicConfigurationKey

data class DoubleDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a Double value type.

DoubleDynamicConfigurationValue

typealias DoubleDynamicConfigurationValue = DynamicConfigurationValue<Double>

A representation of a configuration value of type Double with update information.

DoubleListDynamicConfigurationKey

data class DoubleListDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a List<Double> value type.

DoubleListDynamicConfigurationValue

typealias DoubleListDynamicConfigurationValue = DynamicConfigurationValue<List<Double>>

A representation of a configuration value of type List<Double> with update information.

DoubleListStaticConfigurationKey

data class DoubleListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Double> value type.

DoubleStaticConfigurationKey

data class DoubleStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Double value type.

DynamicConfigurationGroup

data class DynamicConfigurationGroup(val group: String)

A group of related configurations.

DynamicConfigurationKey

sealed class DynamicConfigurationKey

A key used to refer to a dynamic configuration of a certain group and a type.

DynamicConfigurationProvider

interface DynamicConfigurationProvider : ComposableDynamicConfigurationProvider

A dynamic configuration provider for services.

DynamicConfigurationValue

open class DynamicConfigurationValue<T : Any>(val valueEntries: SortedSet<DynamicConfigurationValue.ValueEntry<T>>)

A representation of a configuration value of type T with update information. It contains a non-empty set of value entries valueEntries, sorted ascending by version.

EnumDynamicConfigurationKey

data class EnumDynamicConfigurationKey<E : Enum<*>>(val group: DynamicConfigurationGroup, val id: String, val enumClassRef: KClass<E>) : DynamicConfigurationKey

A key used to refer to a dynamic configuration of enum type E.

EnumDynamicConfigurationValue

class EnumDynamicConfigurationValue<E : Enum<E>>(valueEntries: SortedSet<DynamicConfigurationValue.ValueEntry<E>>) : DynamicConfigurationValue<E>

A representation of a configuration value of the enum type E with update information.

FloatDynamicConfigurationKey

data class FloatDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a Float value type.

FloatDynamicConfigurationValue

typealias FloatDynamicConfigurationValue = DynamicConfigurationValue<Float>

A representation of a configuration value of type Float with update information.

FloatListDynamicConfigurationKey

data class FloatListDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a List<Float> value type.

FloatListDynamicConfigurationValue

typealias FloatListDynamicConfigurationValue = DynamicConfigurationValue<List<Float>>

A representation of a configuration value of type List<Float> with update information.

FloatListStaticConfigurationKey

data class FloatListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Float> value type.

FloatStaticConfigurationKey

data class FloatStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Float value type.

IntDynamicConfigurationKey

data class IntDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with an Integer value type.

IntDynamicConfigurationValue

typealias IntDynamicConfigurationValue = DynamicConfigurationValue<Int>

A representation of a configuration value of type Int with update information.

IntListDynamicConfigurationKey

data class IntListDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a List<Int> value type.

IntListDynamicConfigurationValue

typealias IntListDynamicConfigurationValue = DynamicConfigurationValue<List<Int>>

A representation of a configuration value of type List<Int> with update information.

IntListStaticConfigurationKey

data class IntListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Int> value type.

IntStaticConfigurationKey

data class IntStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Int value type.

LongDynamicConfigurationKey

data class LongDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a Long value type.

LongDynamicConfigurationValue

typealias LongDynamicConfigurationValue = DynamicConfigurationValue<Long>

A representation of a configuration value of type Long with update information.

LongListDynamicConfigurationKey

data class LongListDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a List<Long> value type.

LongListDynamicConfigurationValue

typealias LongListDynamicConfigurationValue = DynamicConfigurationValue<List<Long>>

A representation of a configuration value of type List<Long> with update information.

LongListStaticConfigurationKey

data class LongListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Long> value type.

LongStaticConfigurationKey

data class LongStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Long value type.

OptBooleanListStaticConfigurationKey

data class OptBooleanListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Boolean>? value type.

OptBooleanStaticConfigurationKey

data class OptBooleanStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Boolean? value type.

OptDoubleListStaticConfigurationKey

data class OptDoubleListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Double>? value type.

OptDoubleStaticConfigurationKey

data class OptDoubleStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Double? value type.

OptFloatListStaticConfigurationKey

data class OptFloatListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Float>? value type.

OptFloatStaticConfigurationKey

data class OptFloatStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Float? value type.

OptIntListStaticConfigurationKey

data class OptIntListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Int>? value type.

OptIntStaticConfigurationKey

data class OptIntStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Int? value type.

OptLongListStaticConfigurationKey

data class OptLongListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<Long>? value type.

OptLongStaticConfigurationKey

data class OptLongStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a Long? value type.

OptStringListStaticConfigurationKey

data class OptStringListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<String>? value type.

OptStringStaticConfigurationKey

data class OptStringStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a String? value type.

StaticConfigurationKey

sealed class StaticConfigurationKey

The key to refer to a static configuration of a certain type. Configuration may be optional (indicated by an Opt prefix) or not. When a configuration's value is requested through StaticConfigurationProvider, an optional key allows null to be returned. Other keys require a value to be set and throw an exception if no value is available.

StaticConfigurationProvider

interface StaticConfigurationProvider : ComposableStaticConfigurationProvider

Static configuration provider for frontends and services.

StringDynamicConfigurationKey

data class StringDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a String value type.

StringDynamicConfigurationValue

typealias StringDynamicConfigurationValue = DynamicConfigurationValue<String>

A representation of a configuration value of type String with update information.

StringListDynamicConfigurationKey

data class StringListDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

A key used to refer to a dynamic configuration with a List<String> value type.

StringListDynamicConfigurationValue

typealias StringListDynamicConfigurationValue = DynamicConfigurationValue<List<String>>

A representation of a configuration value of type List<String> with update information.

StringListStaticConfigurationKey

data class StringListStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a List<String> value type.

StringStaticConfigurationKey

data class StringStaticConfigurationKey(val id: String) : StaticConfigurationKey

A key used to refer to a static configuration with a String value type.

Functions

get

operator fun ComposableDynamicConfigurationProvider.get(key: DynamicConfigurationKey): Any?

operator fun DynamicConfigurationProvider.get(key: DynamicConfigurationKey): DynamicConfigurationValue<out Any>

A dispatch method for subtypes of DynamicConfigurationKey since overloaded get methods cannot be called with argument of DynamicConfigurationKey type.

operator fun ComposableStaticConfigurationProvider.get(key: StaticConfigurationKey): Any?

operator fun StaticConfigurationProvider.get(key: StaticConfigurationKey): Any?

A dispatch method for subtypes of StaticConfigurationKey since overloaded get methods cannot be called with argument of StaticConfigurationKey type.