shared-compiler/org.jetbrains.kotlinx.jupyter.startup.parameters/MutableBoundKernelParameter

MutableBoundKernelParameter

class MutableBoundKernelParameter<T : Any>(parameter: KernelParameter<T>, val valueUpdater: (T?) -> Unit, val valueProvider: () -> T?) : BoundKernelParameter<T>

Class that extends BoundKernelParameter with the ability to update the parameter value. This allows for both parsing and serializing parameter values.

Parameters

The type of value that this parameter represents

Constructors

MutableBoundKernelParameter

constructor(parameter: KernelParameter<T>, property: KMutableProperty0<T?>)

Convenience constructor that uses a mutable property for both value updating and providing.

constructor(parameter: KernelParameter<T>, valueUpdater: (T?) -> Unit, valueProvider: () -> T?)

Properties

parameter

val parameter: KernelParameter<T>

The parameter handler to use for serialization

valueProvider

open override val valueProvider: () -> T?

Function that provides the current value of the parameter

valueUpdater

val valueUpdater: (T?) -> Unit

Function that updates the stored value of the parameter

Functions

serialize

fun serialize(argsBuilder: MutableList<String>)

Serializes the current parameter value and adds it to the argument list. If the value is null or the parameter handler returns null, nothing is added.

tryParse

fun tryParse(arg: String): Boolean

Attempts to parse a command-line argument and update the parameter value if successful.