gradle/org.gradle.kotlin.dsl/KotlinSettingsScriptTemplate

KotlinSettingsScriptTemplate

abstract class KotlinSettingsScriptTemplate(host: KotlinScriptHost<Settings>) : DefaultKotlinScript, PluginAware(source)

Base class for Gradle Kotlin DSL standalone Settings scripts IDE support.

This class has the Incubating-level compatibility guarantees but is not annotated as such to avoid Unstable API warnings caused by the IDE using this class as the Kotlin DSL script template. When the IDE chooses to use this script template, there is no direct usage of an incubating API by the build author, but usages of the members, such as plugins, are still reported as unstable API usages. See: issue 34820.

Since

8.1

Constructors

KotlinSettingsScriptTemplate

constructor(host: KotlinScriptHost<Settings>)

Properties

open override val logger: Logger

Logger for scripts. You can use this in your script to write log messages.

open override val logging: LoggingManager

The LoggingManager which can be used to receive logging and to control the standard output/error capture for this script. By default, System.out is redirected to the Gradle logging system at the QUIET log level, and System.err is redirected at the ERROR log level.

open override val pluginManager: PluginManager?

open override val plugins: PluginContainer?

open override val resources: ResourceHandler

Provides access to resource-specific utility methods, for example factory methods that create various resources.

Functions

open override fun apply(@DelegatesTo(value = ObjectConfigurationAction::class) closure: Closure<*>?)

open override fun apply(options: Map<String?, *>?)

open override fun apply(action: Action<in ObjectConfigurationAction?>?)

inline fun <T : Plugin<*>> PluginAware.apply()

Applies the plugin of the given type T. Does nothing if the plugin has already been applied.

inline fun PluginAware.apply(vararg options: Pair<String, Any>)

Kotlin extension function for org.gradle.api.plugins.PluginAware.apply.

fun PluginAware.apply(from: Any? = null, plugin: String? = null, to: Any? = null)

Applies the given plugin or script.

inline fun <T : Plugin<*>> PluginAware.applyTo(vararg targets: Any)

Applies the plugin of the given type T to the specified object. Does nothing if the plugin has already been applied.

open override fun copy(configuration: Action<CopySpec>): WorkResult

Copies the specified files.

open override fun copySpec(): CopySpec

open override fun copySpec(configuration: Action<CopySpec>): CopySpec

Creates a {@link CopySpec} which can later be used to copy files or create an archive.

open override fun delete(configuration: Action<DeleteSpec>): WorkResult

Deletes the specified files.

open override fun delete(vararg paths: Any): Boolean

Deletes files and directories.

open override fun file(path: Any): File

open override fun file(path: Any, validation: PathValidation): File

Resolves a file path relative to this script's target base directory.

open override fun files(vararg paths: Any): ConfigurableFileCollection

open override fun files(paths: Any, configuration: Action<ConfigurableFileCollection>): ConfigurableFileCollection

Creates a ConfigurableFileCollection containing the given files.

open override fun fileTree(baseDir: Any): ConfigurableFileTree

open override fun fileTree(baseDir: Any, configuration: Action<ConfigurableFileTree>): ConfigurableFileTree

Creates a new ConfigurableFileTree using the given base directory.

fun getBuildscript(): ScriptHandler

The ScriptHandler for this script.

getPluginManager

open override fun getPluginManager(): PluginManager?

open override fun getPlugins(): PluginContainer?

open override fun mkdir(path: Any): File

Creates a directory and returns a file pointing to it.

open fun plugins(block: PluginDependenciesSpecScope.() -> Unit)

Configures the plugin dependencies for the project's settings.

open override fun relativePath(path: Any): String

Returns the relative path from this script's target base directory to the given path.

open override fun tarTree(tarPath: Any): FileTree

Creates a new FileTree which contains the contents of the given TAR file.

open override fun uri(path: Any): URI

Resolves a file path to a URI, relative to this script's target base directory.

open override fun zipTree(zipPath: Any): FileTree

Creates a new FileTree which contains the contents of the given ZIP file.