Spec

interface Spec

Config spec is specification for config.

Config spec describes a group of items with common prefix, which can be loaded into config together using Config.addSpec. Config spec also provides convenient API to specify item in it without hand-written object declaration.

Types

Companion

object Companion

Functions

addInnerSpec

abstract fun addInnerSpec(spec: Spec)

Add the specified inner spec into this config spec.

addItem

abstract fun addItem(item: Item<*>)

Add the specified item into this config spec.

get

open operator fun get(path: String): Spec

Returns sub-spec in the specified path.

plus

open operator fun plus(spec: Spec): Spec

Returns a config spec overlapped by the specified facade config spec.

qualify

open fun qualify(item: Item<*>): String

Qualify item name with prefix of this config spec.

withFallback

open fun withFallback(spec: Spec): Spec

Returns a config spec backing by the specified fallback config spec.

withPrefix

open fun withPrefix(prefix: String): Spec

Returns config spec with the specified additional prefix.

Properties

innerSpecs

abstract val innerSpecs: Set<Spec>

Set of inner specs in this config spec.

items

abstract val items: Set<Item<*>>

Set of specified items in this config spec.

prefix

abstract val prefix: String

Common prefix for items in this config spec.

Inheritors

ConfigSpec

Extensions

lazy

inline fun <T> Spec.lazy(name: String? = null, description: String = "", noinline thunk: (config: ItemContainer) -> T): LazyProperty<T>

Specify a lazy item in this config spec.

optional

inline fun <T> Spec.optional(default: T, name: String? = null, description: String = ""): OptionalProperty<T>

Specify an optional item in this config spec.

required

inline fun <T> Spec.required(name: String? = null, description: String = ""): RequiredProperty<T>

Specify a required item in this config spec.

Sources

jvm source