kraftlin-config-core/io.github.kraftlin.config/AbstractConfig/ConfigWrapper

ConfigWrapper

interface ConfigWrapper

An abstraction for an underlying configuration store. Decouples config delegates from the underlying config framework.

Functions

addDefault

abstract fun addDefault(path: String, value: Any)

Adds a default value to be used in absence of a value provided by the client.

getBoolean

abstract fun getBoolean(path: String): Boolean

Gets the specified Boolean configuration value. If the value is not set or not a valid boolean, the default value provided by addDefault is returned.

getBooleanList

abstract fun getBooleanList(path: String): List<Boolean>

Gets the specified List of Boolean configuration value. If the value is not set or not a valid boolean list, the default value provided by addDefault is returned.

getComments

abstract fun getComments(path: String): List<String>

Returns the YAML comments above the given path, or an empty list if none.

getDouble

abstract fun getDouble(path: String): Double

Gets the specified Double configuration value. If the value is not set or not a valid double, the default value provided by addDefault is returned.

getDoubleList

abstract fun getDoubleList(path: String): List<Double>

Gets the specified List of Double configuration value. If the value is not set or not a valid double list, the default value provided by addDefault is returned.

getInt

abstract fun getInt(path: String): Int

Gets the specified Int configuration value. If the value is not set or not a valid integer, the default value provided by addDefault is returned.

getIntegerList

abstract fun getIntegerList(path: String): List<Int>

Gets the specified List of Int configuration value. If the value is not set or not a valid integer list, the default value provided by addDefault is returned.

getKeys

abstract fun getKeys(deep: Boolean): Set<String>

Gets all keys present in the config store.

getLong

abstract fun getLong(path: String): Long

Gets the specified Long configuration value. If the value is not set or not a valid long, the default value provided by addDefault is returned.

getLongList

abstract fun getLongList(path: String): List<Long>

Gets the specified List of Long configuration value. If the value is not set or not a valid long list, the default value provided by addDefault is returned.

getMap

abstract fun getMap(path: String): Map<String, Any>

Gets the specified flat Map of Any indexed by String configuration value. If the value is not set or not a valid Map, the default value provided by addDefault is returned.

getString

abstract fun getString(path: String): String

Gets the specified String configuration value. If the value is not set or not a valid string, the default value provided by addDefault is returned.

getStringList

abstract fun getStringList(path: String): List<String>

Gets the specified List of String configuration value. If the value is not set or not a valid string list, the default value provided by addDefault is returned.

reloadConfig

abstract fun reloadConfig()

Reloads all configuration values from the underlying config representation, for example from file.

remove

abstract fun remove(path: String)

Removes the value at the specified path.

save

abstract fun save()

Persists any changes in configuration values to disk. WARNING: overwrites any changes done to the config file on disk!

saveDefaults

abstract fun saveDefaults()

Stores the default values provided by addDefault for any path that has no user provided value. If the underlying config representation does not exist, it is created and initiated with the default values.

set

abstract fun set(path: String, value: Any?)

Sets the value in the underlying config. Use save to persist changes.

setComments

abstract fun setComments(path: String, comments: List<String>)

Sets the YAML comments above the given path. Applied on the next save.