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

SimpleNamedKernelStringParameter

class SimpleNamedKernelStringParameter(name: String) : SimpleNamedKernelParameter<String>

Represents a simple named kernel parameter with a string value. This parameter is identified by a single alias provided via the name property. It inherits functionality to parse and serialize command-line arguments in the format "-name=value".

Parameters

name

The name of the parameter, which serves as its alias.

Constructors

SimpleNamedKernelStringParameter

constructor(name: String)

Properties

aliases

val aliases: List<String>

List of alternative names for this parameter

name

val name: String

Functions

parseValue

open override fun parseValue(argValue: String, previousValue: String?): String

Parses a string value into a value of type T. This method is called after the parameter name has been matched and the value extracted.

serialize

open override fun serialize(value: String): String?

Serializes a value to a command-line argument with the parameter's primary alias.

serializeValue

open override fun serializeValue(value: String): String

Serializes a value of type T to a string representation (without the parameter name prefix).

tryParse

open override fun tryParse(arg: String, previousValue: String?): String?

Attempts to parse a command-line argument if it matches one of this parameter's aliases. Checks if the argument starts with "-alias=" for any of the aliases.