RequiredItem

open class RequiredItem<T> @JvmOverloads() constructor(spec: Spec, name: String, description: String, type: JavaType?, nullable: Boolean) : Item<T>

Required item without default value.

Required item must be set with value before retrieved in config.

Constructors

RequiredItem

@JvmOverloads()

fun RequiredItem(spec: Spec, name: String, description: String = "", type: JavaType? = null, nullable: Boolean = false)

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 override val isRequired: Boolean = true

Whether this is a required item or not.

name

val name: String

Item name without prefix.

nullable

val nullable: Boolean

path

val path: Path

Item path without prefix.

spec

val spec: Spec

Config spec that contains this item.

type

val type: JavaType

Type of value that can be associated with this item.

Sources

jvm source