runner-api/dev.ust.zinc.grader.util/CmdUtils/Var/Result

Result

inner class Result<T>(val v: CmdUtils.Var, val fileNameConvention: CmdUtils.Var.() -> String, val envVarNameConvention: CmdUtils.Var.() -> String, val transform: CmdUtils.Var.(List<String>) -> T = { it as T })

Represents different kinds of results a variable can emit.

Parameters

T

output type of the result: list of string or string etc.

Constructors

constructor(v: CmdUtils.Var, fileNameConvention: CmdUtils.Var.() -> String, envVarNameConvention: CmdUtils.Var.() -> String, transform: CmdUtils.Var.(List<String>) -> T = { it as T })

Types

private inner class Content(outputHandler: CmdOutputHandler)

Container for content received from outputHandler of the result.

Properties

val asFile: String

Alias for getting filePath.

val asLiteral: String

Returns an environment variable storing the result, if the CmdOutputHandler did use environment variables.

private lateinit var content: CmdUtils.Var.Result.Content<T>

val envName: String

Returns the environment variable used to store the result, if the CmdOutputHandler did use environment variables.

envVarNameConvention

val envVarNameConvention: CmdUtils.Var.() -> String

val fileName: String

Returns the file name used to store the result.

fileNameConvention

val fileNameConvention: CmdUtils.Var.() -> String

val filePath: String

Returns the absolute path of fileName within the stage execution environment host.

val printLiteral: String

Returns a command for printing the content of environment variable storing the result, if the CmdOutputHandler did use environment variables.

val transform: CmdUtils.Var.(List<String>) -> T

additional transformation from list of lines to a desired value of type T.

val v: CmdUtils.Var

the underlying Var.

Functions

fun readyContent(outputHandler: CmdOutputHandler): T

Initializes result content once if not yet: retrieves it through outputHandler and memoizes it. Returns the already retrieved content.