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

FieldConfigScope

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

This class supports both method chaining and block-style configuration, allowing flexible and type-safe field definitions.

Method Chaining Style

def.field(AppConfig::port)
    .default(8080)
    .range(1..65535)
    .validate { require(it > 0) { "Port must be positive" } }

Block Style

def.field(AppConfig::apiKey) {
    required()
    validate { require(it.isNotBlank()) { "API key cannot be blank" } }
}

Mixed Style

Both styles can be combined as needed:

def.field(AppConfig::timeout)
    .default(30)
    .range(1L..300L)

Parameters

the type of the value associated with this field

Constructors

FieldConfigScope

constructor()

Functions

default

fun default(value: V): FieldConfigScope<V>

Sets the default value for the configuration field.

ifNull

fun ifNull(handler: (Any?, Any?) -> Unit): FieldConfigScope<V>

fun ifNull(handler: KClass<out ErrorHandlerWith>): FieldConfigScope<V>

Sets a handler to be invoked when the configuration field is null or missing.

loader

fun loader(loader: FieldLoader): FieldConfigScope<V>

Sets a custom loader for the configuration field.

name

fun name(yamlName: String): FieldConfigScope<V>

Specifies the YAML/JSON key name for this field if it differs from the property name.

notBlank

@JvmName(name = "notBlank")

fun notBlank(): FieldConfigScope<V>

Validates that a String field is not blank (not empty and not just whitespace).

range

fun range(range: IntRange): FieldConfigScope<V>

Sets a range validator for the configuration field using an IntRange.

fun range(range: LongRange): FieldConfigScope<V>

Sets a range validator for the configuration field using a LongRange.

fun range(min: Long = Long.MIN_VALUE, max: Long = Long.MAX_VALUE): FieldConfigScope<V>

Sets a range validator for the configuration field using explicit min/max values.

required

fun required(soft: Boolean = false): FieldConfigScope<V>

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

requiredWithDefault

fun requiredWithDefault(value: V): FieldConfigScope<V>

Shortcut method to mark a field as required and provide a default value.

validate

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

Adds a custom validator for the configuration field.

validators

fun validators(vararg blocks: (V) -> Unit): FieldConfigScope<V>

Adds multiple validators at once.