yacla-core/net.ririfa.yacla.schema/FieldConfigScope

FieldConfigScope

class FieldConfigScope<V>

Provides a DSL-style builder to configure fields in a configuration schema.

This class allows defining field-specific properties, validation logic, and custom behavior for configuration loading and parsing. It supports defining default values, marking fields as required, setting value ranges, and adding custom deserialization logic.

Parameters

V

the type of the value associated with this field

Constructors

FieldConfigScope

constructor()

Functions

buildDefinition

fun buildDefinition(prop: KProperty1<*, *>): FieldDefinition

Builds a definition for a configuration field based on the provided property and the settings specified within the FieldConfigScope.

fun default(value: V)

Sets the default value for the configuration field.

fun ifNull(handler: KClass<out ErrorHandlerWith>)

Sets a handler to be used when the configuration field is null.

fun loader(loader: FieldLoader)

Sets a custom loader for the configuration field.

fun name(yamlName: String)

fun range(min: Long = Long.MIN_VALUE, max: Long = Long.MAX_VALUE)

Sets a range validator for the configuration field.

fun required(soft: Boolean = false)

Marks the field as required or soft-required during configuration validation.

fun validate(block: (V) -> Unit)

Adds a custom validator for the configuration field.