Loader

class Loader(config: Config, provider: Provider)

Loader to load source from various input formats.

Parameters

config

parent config

Constructors

Loader
Link copied to clipboard
fun Loader(config: Config, provider: Provider)
parent config

Functions

bytes
Link copied to clipboard
fun bytes(content: ByteArray): Config
Returns a child config containing values from specified byte array.
fun bytes(content: ByteArray, offset: Int, length: Int): Config
Returns a child config containing values from specified portion of byte array.
file
Link copied to clipboard
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.
inputStream
Link copied to clipboard
fun inputStream(inputStream: InputStream): Config
Returns a child config containing values from specified input stream.
reader
Link copied to clipboard
fun reader(reader: Reader): Config
Returns a child config containing values from specified reader.
resource
Link copied to clipboard
fun resource(resource: String, optional: Boolean = this.optional): Config
Returns a child config containing values from specified resource.
string
Link copied to clipboard
fun string(content: String): Config
Returns a child config containing values from specified string.
url
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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.

Properties

config
Link copied to clipboard
val config: Config
Parent config for all child configs loading source in this loader.
optional
Link copied to clipboard
val optional: Boolean
provider
Link copied to clipboard
val provider: Provider
Source provider to provide source from various input format.

Sources

jvm source
Link copied to clipboard