yacla-core/net.ririfa.yacla.annotation

Package-level declarations

Types

Link copied to clipboard
@Target(value = ElementType.FIELD)
@Retention(value = RetentionPolicy.RUNTIME)
annotation class CustomLoader
Specifies a custom FieldLoader to transform the raw parsed value into the final value assigned to the annotated field.
Link copied to clipboard
@Target(value = ElementType.FIELD)
@Retention(value = RetentionPolicy.RUNTIME)
annotation class CustomValidateHandler
Attaches a custom FieldValidator to the annotated field, allowing advanced validation logic beyond built-in annotations like @Required or @Range.
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class Default(val value: String)

Specifies a default value to be used for a field when the parsed configuration does not provide a value or the value is null/empty.

Link copied to clipboard
@Target(value = ElementType.FIELD)
@Retention(value = RetentionPolicy.RUNTIME)
annotation class IfNullEvenRequired
Indicates that if the annotated field is found to be null or blank during config loading, the specified ErrorHandlerWith should be invoked instead of failing immediately.
Link copied to clipboard
@FunctionalInterface
interface JLoaderScope

Java-compatible DSL scope interface for defining configuration loaders within a shared default context using net.ririfa.yacla.Yacla.withDefaults.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class NamedRecord(val value: String)

Specifies the field name to be used for mapping a Java Record component when parameter names are not available at runtime.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class Range(val min: Long = Long.MIN_VALUE, val max: Long = Long.MAX_VALUE)

Specifies a valid numeric range for a field.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class Required(val soft: Boolean = false, val named: String = "")

Marks a field as required in the configuration.