script/ktx.script/KotlinScriptEngine

KotlinScriptEngine

class KotlinScriptEngine

Executes Kotlin scripts in runtime.

Built on top of the official Kotlin scripting host from the kotlin-scripting-jvm-host package.

Constructors

KotlinScriptEngine

constructor()

Properties

variables

val variables: MutableMap<String, Any?>

Functions

evaluate

fun evaluate(scriptFile: FileHandle): Any?

Executes the selected scriptFile. Returns the last script's expression as the result. If unable to execute the script, ScriptEngineException will be thrown.

fun evaluate(script: String): Any?

Executes the selected script. Returns the last script's expression as the result. If unable to execute the script, ScriptEngineException will be thrown.

evaluateAs

inline fun <T> evaluateAs(scriptFile: FileHandle): T

Executes the selected scriptFile and returns an instance of T. If the script is not an instance of T, ClassCastException will be thrown. If unable to execute the script, ScriptEngineException will be thrown.

inline fun <T> evaluateAs(script: String): T

Executes the selected script and returns an instance of T. If the script is not an instance of T, ClassCastException will be thrown. If unable to execute the script, ScriptEngineException will be thrown.

evaluateOn

fun evaluateOn(receiver: Any, scriptFile: FileHandle): Any?

Executes the selected scriptFile on the receiver object. The receiver will be available as this throughout the script.

fun evaluateOn(receiver: Any, script: String): Any?

Executes the selected script on the receiver object. The receiver will be available as this throughout the script.

get

inline operator fun <T> get(variable: String): T?

Retrieves the value assigned to variable in the context of this engine.

import

fun import(import: String, alias: String? = null)

Imports the selected import using an optional alias. Wildcard imports using * are supported, but they cannot have an alias.

importAll

fun importAll(imports: Iterable<String>)

fun importAll(vararg imports: String)

Imports the selected imports within the script context. Wildcard imports using * are accepted. The imports will be available in future scripts.

remove

fun remove(variable: String): Any?

Removes the variable from the context of this engine. Returns the value assigned to the variable. Returns null if no value is assigned to variable.

set

operator fun <T> set(variable: String, value: T)

Assigns the selected value to the variable name in the context of this engine. The variable will be available in the future scripts.

setPackage

fun setPackage(name: String)

Sets the package of the future scripts to name.