DefaultLoaders

class DefaultLoaders(config: Config, transform: (Source) -> Source?)

Default loaders for config.

If transform is provided, source will be applied the given transform function when loaded.

Parameters

config

parent config for loader

transform

the given transformation function

Constructors

DefaultLoaders

fun DefaultLoaders(config: Config, transform: (Source) -> Source? = null)

parent config for loader

Functions

disabled

fun disabled(feature: Feature): DefaultLoaders

dispatchExtension

fun dispatchExtension(extension: String, source: String = ""): Loader

Returns corresponding loader based on extension.

enabled

fun enabled(feature: Feature): DefaultLoaders

env

@JvmOverloads()

fun env(nested: Boolean = true): Config

Returns a child config containing values from system environment.

envMap

@JvmOverloads()

fun envMap(map: Map<String, String>, nested: Boolean = true): Config

file

fun file(file: File, optional: Boolean = this.optional): Config

Returns a child config containing values from specified file.

fun file(file: String, optional: Boolean = this.optional): Config

Returns a child config containing values from specified file path.

mapped

fun mapped(transform: (Source) -> Source): DefaultLoaders

Returns default loaders applied the given transform function.

orMapped

fun Provider.orMapped(): Provider

fun Source.orMapped(): Source

prefixed

fun prefixed(prefix: String): DefaultLoaders

Returns default loaders where sources have specified additional prefix.

scoped

fun scoped(path: String): DefaultLoaders

Returns default loaders where sources are scoped in specified path.

source

fun source(provider: Provider): Loader

Loader for a source from the specified provider.

systemProperties

fun systemProperties(): Config

Returns a child config containing values from system properties.

url

fun url(url: URL, optional: Boolean = this.optional): Config

Returns a child config containing values from specified url.

fun url(url: String, optional: Boolean = this.optional): Config

Returns a child config containing values from specified url string.

watchFile

fun watchFile(file: File, delayTime: Long = 5, unit: TimeUnit = TimeUnit.SECONDS, context: CoroutineContext = Dispatchers.Default, optional: Boolean = this.optional, onLoad: (config: Config, source: Source) -> Unit? = null): Config

Returns a child config containing values from specified file, and reloads values when file content has been changed.

fun watchFile(file: String, delayTime: Long = 5, unit: TimeUnit = TimeUnit.SECONDS, context: CoroutineContext = Dispatchers.Default, optional: Boolean = this.optional, onLoad: (config: Config, source: Source) -> Unit? = null): Config

Returns a child config containing values from specified file path, and reloads values when file content has been changed.

watchUrl

fun watchUrl(url: URL, period: Long = 5, unit: TimeUnit = TimeUnit.SECONDS, context: CoroutineContext = Dispatchers.Default, optional: Boolean = this.optional, onLoad: (config: Config, source: Source) -> Unit? = null): Config

Returns a child config containing values from specified url, and reloads values periodically.

fun watchUrl(url: String, period: Long = 5, unit: TimeUnit = TimeUnit.SECONDS, context: CoroutineContext = Dispatchers.Default, optional: Boolean = this.optional, onLoad: (config: Config, source: Source) -> Unit? = null): Config

Returns a child config containing values from specified url string, and reloads values periodically.