1.1.0+rc.3

yacla-core/net.ririfa.yacla.loader.util/UpdateContext

UpdateContext

data class UpdateContext(val parser: ConfigParser, val targetFile: Path, val resourcePath: String, val logger: YaclaLogger?)

Represents the context used during a configuration update operation.

This context provides all necessary information to perform an update:

the target configuration file on disk
the resource path to the default configuration inside the classpath
the parser being used for this configuration format
an optional logger for outputting update process logs

It is passed to net.ririfa.yacla.loader.UpdateStrategy.updateIfNeeded to provide consistent access to the environment and resources required for updating the config file.

Constructors

constructor(parser: ConfigParser, targetFile: Path, resourcePath: String, logger: YaclaLogger?)

Properties

val logger: YaclaLogger?

an optional YaclaLogger for logging update operations

val parser: ConfigParser

the ConfigParser used to parse the configuration file

val resourcePath: String

the path to the default configuration resource in the classpath

val targetFile: Path

the Path to the target configuration file on disk