required

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

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

  • Required (strict): The field must be explicitly provided in the configuration file. Loading will fail if the field is missing or null.

  • Soft-required: A warning is logged if the field is missing, but loading continues.

Example:

// Strict requirement
field(AppConfig::apiKey).required()

// Soft requirement (logs warning but doesn't fail)
field(AppConfig::debugMode).required(soft = true)

Return

this FieldConfigScope for method chaining

Parameters

soft

if true, marks the field as soft-required; otherwise, it is marked as strictly required