yacla-core/net.ririfa.yacla/Yacla/withDefaults

withDefaults

fun <R> withDefaults(settings: LoaderSettings, block: LoaderScope.() -> R): R

Creates a DSL scope that applies the provided default settings to all loaders defined inside.

Example (Kotlin DSL):

val config = Yacla.withDefaults(sharedSettings) {
    loader<MainConfig> {
        fromResource("/defaults/main.yml")
        toFile(Paths.get("config/main.yml"))
    }.config
}

Return

the result returned from the provided block

Parameters

settings

common loader defaults such as parser, logger, and auto-update flag

block

a lambda with LoaderScope receiver to define one or more loaders

@JvmStatic

fun <R> withDefaults(settings: LoaderSettings, block: Function<JLoaderScope, R>): R

Creates a functional scope for defining multiple loaders with common defaults, for use in Java.

Example (Java):

LoaderSettings settings = new LoaderSettings(parser, logger, true);

MainConfig config = Yacla.withDefaults(settings, scope -> {
    ConfigLoader<MainConfig> loader = scope.loader(MainConfig.class, b -> {
        b.fromResource("/defaults/main.yml");
        b.toFile(Paths.get("config/main.yml"));
    });
    return loader.getConfig();
});

Return

the result returned from the provided function

Parameters

settings

common loader defaults such as parser, logger, and auto-update flag

block

function receiving a JLoaderScope for defining one or more loaders