gradle/org.gradle.kotlin.dsl/KotlinInitScript

KotlinInitScript

abstract class ~~KotlinInitScript~~(host: KotlinScriptHost<Gradle>) : InitScriptApi(source)

Deprecated

Will be removed in Gradle 10

Legacy base class for Gradle Kotlin DSL standalone Gradle scripts IDE support, aka. init scripts.

See also

KotlinGradleScriptTemplate

Constructors

KotlinInitScript

constructor(host: KotlinScriptHost<Gradle>)

Properties

open val buildPath: String

open override val delegate: Gradle

open val extensions: ExtensionContainer

val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

open val gradle: Gradle

open val gradleHomeDir: File?

gradleUserHomeDir

open val gradleUserHomeDir: File

open val gradleVersion: String

open val includedBuilds: MutableCollection<IncludedBuild>

val initscript: ScriptHandler

The ScriptHandler for this script.

open val lifecycle: GradleLifecycle

val logger: Logger

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

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 val parent: Gradle?

open val pluginManager: PluginManager

open val plugins: PluginContainer

open val providers: ProviderFactory

val resources: ResourceHandler

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

open val rootProject: Project

open val sharedServices: BuildServiceRegistry

open val startParameter: StartParameter

open val taskGraph: TaskExecutionGraph

Functions

addBuildListener

open override fun addBuildListener(buildListener: BuildListener)

open override fun addListener(listener: Any)

addProjectEvaluationListener

open override fun addProjectEvaluationListener(listener: ProjectEvaluationListener): ProjectEvaluationListener

open override fun afterProject(closure: Closure<Any>)

open override fun afterProject(action: Action<in Project>)

open override fun allprojects(action: Action<in Project>)

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

Applies zero or more plugins or scripts.

open override fun apply(closure: Closure<Any>)

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

inline fun <T : Plugin<Gradle>> Gradle.apply()

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 beforeProject(closure: Closure<Any>)

open override fun beforeProject(action: Action<in Project>)

open override fun beforeSettings(closure: Closure<*>)

open override fun beforeSettings(action: Action<in Settings>)

open override fun ~~buildFinished~~(closure: Closure<Any>)

open override fun ~~buildFinished~~(action: Action<in BuildResult>)

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

fun copy(configuration: CopySpec.() -> Unit): WorkResult

Copies the specified files.

fun copySpec(): CopySpec

fun copySpec(configuration: CopySpec.() -> Unit): CopySpec

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

fun delete(configuration: DeleteSpec.() -> Unit): WorkResult

Deletes the specified files.

fun delete(vararg paths: Any): Boolean

Deletes files and directories.

fun file(path: Any): File

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

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

fun files(vararg paths: Any): ConfigurableFileCollection

fun files(paths: Any, configuration: ConfigurableFileCollection.() -> Unit): ConfigurableFileCollection

Creates a ConfigurableFileCollection containing the given files.

fun fileTree(baseDir: Any): ConfigurableFileTree

fun fileTree(baseDir: Any, configuration: ConfigurableFileTree.() -> Unit): ConfigurableFileTree

Creates a new ConfigurableFileTree using the given base directory.

open override fun getBuildPath(): String

open override fun getExtensions(): ExtensionContainer

open override fun getGradle(): Gradle

getGradleHomeDir

open override fun getGradleHomeDir(): File?

getGradleUserHomeDir

open override fun getGradleUserHomeDir(): File

getGradleVersion

open override fun getGradleVersion(): String

getIncludedBuilds

open override fun getIncludedBuilds(): MutableCollection<IncludedBuild>

open override fun getLifecycle(): GradleLifecycle

open override fun getParent(): Gradle?

getPluginManager

open override fun getPluginManager(): PluginManager

open override fun getPlugins(): PluginContainer

open override fun getProviders(): ProviderFactory

open override fun getRootProject(): Project

getSharedServices

open override fun getSharedServices(): BuildServiceRegistry

getStartParameter

open override fun getStartParameter(): StartParameter

open override fun getTaskGraph(): TaskExecutionGraph

open override fun includedBuild(name: String): IncludedBuild

open fun initscript(block: ScriptHandlerScope.() -> Unit)

Configures the classpath of the init script.

fun mkdir(path: Any): File

Creates a directory and returns a file pointing to it.

projectsEvaluated

open override fun projectsEvaluated(closure: Closure<Any>)

open override fun projectsEvaluated(action: Action<in Gradle>)

open override fun projectsLoaded(closure: Closure<Any>)

open override fun projectsLoaded(action: Action<in Gradle>)

fun relativePath(path: Any): String

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

open override fun removeListener(listener: Any)

removeProjectEvaluationListener

open override fun removeProjectEvaluationListener(listener: ProjectEvaluationListener)

open override fun rootProject(action: Action<in Project>)

settingsEvaluated

open override fun settingsEvaluated(closure: Closure<Any>)

open override fun settingsEvaluated(action: Action<in Settings>)

fun tarTree(tarPath: Any): FileTree

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

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

fun uri(path: Any): URI

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

open override fun ~~useLogger~~(logger: Any)

fun zipTree(zipPath: Any): FileTree

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