KSLCore/ksl.app.config/BundleRef

BundleRef

@Serializable

data class BundleRef(val paths: List<String> = emptyList(), val bundleId: String)(source)

A document-level reference to a bundle JAR. Used by the Scenario-app workflow (and by the analogous Single / Experiment workflows) to declare which bundle JARs a ksl.app.config.RunConfiguration depends on, so the runtime can load each one and route per-scenario (bundleId, modelId) references against the resulting registry.

bundleId is the authoritative identifier: it matches the ksl.app.bundle.KSLModelBundle.bundleId of the bundle that the document was authored against. At open time, the consumer (typically the Scenario app's open-document flow) tries each entry of paths in order, then silently searches Recent Bundles and ~/.ksl/bundles/ for a JAR whose bundleId matches, then prompts the user to Locate JAR… if none match. See the Scenario app's workflow design document for the full reconciliation sequence.

paths is a list of candidate hint paths. Entries may be absolute, workspace-relative, or contain ~ for the user's home directory. Path expansion and normalisation are the consumer's responsibility; this type stores the strings verbatim as the user supplied them.

Constructors

BundleRef

constructor(paths: List<String> = emptyList(), bundleId: String)

Properties

bundleId

val bundleId: String

the KSLModelBundle.bundleId of the bundle this reference targets; must be non-blank

paths

val paths: List<String>

ordered list of candidate filesystem paths for the bundle JAR; may be empty (e.g. when the authoring user dropped a JAR via the file picker and didn't record a stable path)