detekt-api/dev.detekt.api/Config

Config

interface Config

A configuration holds information about how to configure specific rules.

Types

Companion

object Companion

Properties

parent

abstract val parent: Config?

The reference to a parent Config from this configuration, useful when navigating with subConfig. It's null if this is the top most configuration object.

Functions

subConfig

abstract fun subConfig(key: String): Config

Tries to retrieve part of the configuration based on given key.

subConfigKeys

abstract fun subConfigKeys(): Set<String>

Returns a set of all sub configuration keys.

valueOrDefault

inline fun <T : Any> Config.valueOrDefault(key: String, default: T): T

Retrieves a sub configuration or value based on given key.

valueOrNull

abstract fun <T : Any> valueOrNull(key: String, type: KClass<T>): T?

Retrieves a sub configuration or value based on given key. If the configuration property cannot be found, null is returned.

valueOrNull

inline fun <T : Any> Config.valueOrNull(key: String): T?

Retrieves a sub configuration or value based on given key.