Package com.tomtom.ivi.platform.framework.api.configuration.api

The API of TomTom Digital Cockpit's configuration framework.

Types

Link copied to clipboard
data class BooleanDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

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

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard
data class BooleanListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class BooleanStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
interface ComposableDynamicConfigurationProvider

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

Link copied to clipboard
interface ComposableStaticConfigurationProvider

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

Link copied to clipboard

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

Link copied to clipboard
data class DoubleDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

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

Link copied to clipboard
typealias DoubleDynamicConfigurationValue = DynamicConfigurationValue<Double>

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

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

Link copied to clipboard

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

Link copied to clipboard
data class DoubleListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class DoubleStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class DynamicConfigurationGroup(val group: String)

A group of related configurations.

Link copied to clipboard
sealed class DynamicConfigurationKey

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

Link copied to clipboard

A dynamic configuration provider for services.

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

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

Link copied to clipboard

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

Link copied to clipboard
data class FloatDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

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

Link copied to clipboard
typealias FloatDynamicConfigurationValue = DynamicConfigurationValue<Float>

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

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

Link copied to clipboard

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

Link copied to clipboard
data class FloatListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class FloatStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class IntDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

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

Link copied to clipboard
typealias IntDynamicConfigurationValue = DynamicConfigurationValue<Int>

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

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

Link copied to clipboard
typealias IntListDynamicConfigurationValue = DynamicConfigurationValue<List<Int>>

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

Link copied to clipboard
data class IntListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class IntStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class LongDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

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

Link copied to clipboard
typealias LongDynamicConfigurationValue = DynamicConfigurationValue<Long>

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

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

Link copied to clipboard
typealias LongListDynamicConfigurationValue = DynamicConfigurationValue<List<Long>>

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

Link copied to clipboard
data class LongListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class LongStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptBooleanListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptBooleanStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptDoubleListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptDoubleStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptFloatListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptFloatStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptIntListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptIntStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptLongListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptLongStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptStringListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class OptStringStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

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

Link copied to clipboard

Static configuration provider for frontends and services.

Link copied to clipboard
data class StringDynamicConfigurationKey(val group: DynamicConfigurationGroup, val id: String) : DynamicConfigurationKey

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

Link copied to clipboard
typealias StringDynamicConfigurationValue = DynamicConfigurationValue<String>

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

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

Link copied to clipboard

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

Link copied to clipboard
data class StringListStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Link copied to clipboard
data class StringStaticConfigurationKey(val id: String) : StaticConfigurationKey

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

Functions

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