kotlin-gradle-plugin-api/org.jetbrains.kotlin.gradle.plugin/SubpluginOption

SubpluginOption

open class SubpluginOption(val key: String, lazyValue: Lazy<String>)

Represents an option for a Kotlin compiler plugin, defined by a key and a value.

All options are mapped to the following Kotlin compiler argument format:

"plugin:$pluginId:$key=$value"

pluginId is the KotlinCompilerPluginSupportPlugin.getCompilerPluginId.

Options are added to the relevant compilation task inputs. To exclude options from task inputs, use the InternalSubpluginOption. For options that provide file paths, add the file paths to the FilesSubpluginOption.

Parameters

key

The key associated with this option.

lazyValue

The lazily-initialized value associated with the key.

Inheritors

FilesSubpluginOption

CompositeSubpluginOption

InternalSubpluginOption

Constructors

SubpluginOption

constructor(key: String, value: String)

constructor(key: String, lazyValue: Lazy<String>)

Creates an instance of option with the given key and lazy-initialized value.

Properties

key

val key: String

value

val value: String

The value of this option.