ConfigurationProviderConfig

Deprecated

This API is supposed to only be used internally by IVI and should not be used directly. It may change in the future without providing backward compatibility.

Defines the reference to a configuration provider implementation and how to construct it.

Parameters

configurationProviderName

The name of the configuration provider class.

The configuration provider class name must be formatted in PascalCase and must end with the ConfigurationProvider suffix. The configuration provider class name needs to match a class with the same name. The ConfigurationProvider suffix is mandatory to make it easier for developers to find where the class is used in the code base.

For the StaticConfigurationProviderConfig subclass this class needs to be a subclass of com.tomtom.ivi.platform.framework.api.configuration.api.ComposableStaticConfigurationProvider.

For the DynamicConfigurationProviderConfig subclass this class needs to be a subclass of com.tomtom.ivi.platform.framework.api.configuration.api.ComposableDynamicConfigurationProvider.

implementationModule

The module that contains the configuration provider class.

The package name of the class is obtained from this ModuleReference. If the class resides in a sub package within this module, the sub package can be provided through subPackageName. This subPackageName is appended to the package name of the module, with a period in between.

subPackageName

Optional sub package. If not null, this value is appended to the ModuleReference.packageName of the implementationModule property with a period in between.

constructorArguments

The constructor arguments required to initiate the configuration provider class.

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val subPackageName: String? = null

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int