Item

sealed class Item<T>

Item that can be contained by config.

Item can be associated with value in config, containing metadata for the value. The metadata for value includes name, path, type, description and so on. Item can be used as key to operate value in config, guaranteeing type safety. There are three kinds of item: required item, optional item and lazy item.

See also

com.uchuhimo.konf.Config

Parameters

T

type of value that can be associated with this item.

spec

config spec that contains this item

name

item name without prefix

description

description for this item

Functions

afterSet

fun afterSet(afterSetFunction: (config: Config, T) -> Unit): Handler

Subscribe the update event of this item after every set operation.

beforeSet

fun beforeSet(beforeSetFunction: (config: Config, T) -> Unit): Handler

Subscribe the update event of this item before every set operation.

notifyAfterSet

fun notifyAfterSet(config: Config, value: Any?)

notifyBeforeSet

fun notifyBeforeSet(config: Config, value: Any?)

notifySet

fun notifySet(value: Any?)

onSet

fun onSet(onSetFunction: (T) -> Unit): Handler

Subscribe the update event of this item.

Properties

asLazyItem

val asLazyItem: LazyItem<T>

Cast this item to a lazy item.

asOptionalItem

val asOptionalItem: OptionalItem<T>

Cast this item to an optional item.

asRequiredItem

val asRequiredItem: RequiredItem<T>

Cast this item to a required item.

description

val description: String

Description for this item.

isLazy

open val isLazy: Boolean

Whether this is a lazy item or not.

isOptional

open val isOptional: Boolean

Whether this is an optional item or not.

isRequired

open val isRequired: Boolean

Whether this is a required item or not.

name

val name: String

Item name without prefix.

nullable

val nullable: Boolean = false

path

Item path without prefix.

spec

Config spec that contains this item.

type

val type: JavaType

Type of value that can be associated with this item.

Inheritors

RequiredItem

OptionalItem

LazyItem

Extensions

asName

val Item<*>.asName: String

Sources

jvm source