gradle/org.gradle.kotlin.dsl/KotlinBuildScript

KotlinBuildScript

abstract class ~~KotlinBuildScript~~(host: KotlinScriptHost<Project>) : ProjectDelegate(source)

Deprecated

Will be removed in Gradle 9.0

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

Constructors

KotlinBuildScript

constructor(host: KotlinScriptHost<Project>)

Properties

delegate

open val delegate: Project

extra

val ExtensionAware.extra: ExtraPropertiesExtension

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

Functions

absoluteProjectPath

open override fun absoluteProjectPath(path: String): String

afterEvaluate

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

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

allprojects

open override fun allprojects(configureClosure: Closure<*>)

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

ant

open override fun ant(configureClosure: Closure<*>): AntBuilder

open override fun ant(configureAction: Action<in AntBuilder>): AntBuilder

apply

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

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

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

apply

inline fun <T : Plugin<Project>> Project.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.

applyTo

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.

artifacts

open override fun artifacts(configureClosure: Closure<*>)

open override fun artifacts(configureAction: Action<in ArtifactHandler>)

artifacts

fun Project.artifacts(configuration: ArtifactHandlerScope.() -> Unit)

Configures the artifacts for this project.

beforeEvaluate

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

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

buildscript

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

Configures the build script classpath for this project.

open override fun buildscript(configureClosure: Closure<*>)

buildscript

fun Project.buildscript(action: ScriptHandlerScope.() -> Unit)

Configures the build script classpath for this project.

compareTo

open operator override fun compareTo(other: Project?): Int

components

open override fun components(configuration: Action<in SoftwareComponentContainer>)

configurations

open override fun configurations(configureClosure: Closure<*>)

configure

open override fun configure(object: Any, configureClosure: Closure<*>): Any

open override fun configure(objects: Iterable<*>, configureClosure: Closure<*>): Iterable<*>

open override fun <T> configure(objects: Iterable<T>, configureAction: Action<in T>): Iterable<T>

configure

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

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

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

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

container

open override fun <T> container(type: Class<T>): NamedDomainObjectContainer<T>

open override fun <T> container(type: Class<T>, factoryClosure: Closure<*>): NamedDomainObjectContainer<T>

open override fun <T> container(type: Class<T>, factory: NamedDomainObjectFactory<T>): NamedDomainObjectContainer<T>

container

inline fun <T> Project.container(): NamedDomainObjectContainer<T>

inline fun <T : Any> Project.container(noinline factory: (String) -> T): NamedDomainObjectContainer<T>

Creates a container for managing named objects of the specified type.

inline fun <T : Any> Project.container(type: KClass<T>): NamedDomainObjectContainer<T>

inline fun <T : Any> Project.container(type: KClass<T>, factory: NamedDomainObjectFactory<T>): NamedDomainObjectContainer<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.Project.container.

copy

open override fun copy(closure: Closure<*>): WorkResult

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

copySpec

open override fun copySpec(): CopySpec

open override fun copySpec(closure: Closure<*>): CopySpec

open override fun copySpec(action: Action<in CopySpec>): CopySpec

createAntBuilder

open override fun createAntBuilder(): AntBuilder

defaultTasks

open override fun defaultTasks(vararg defaultTasks: String?)

defaultTasks

inline fun Project.defaultTasks(vararg tasks: Task)

Sets the default tasks of this project. These are used when no tasks names are provided when starting the build.

delete

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

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

dependencies

open override fun dependencies(configureClosure: Closure<*>)

dependencies

fun Project.dependencies(configuration: DependencyHandlerScope.() -> Unit)

Configures the dependencies for this project.

dependencyLocking

open override fun dependencyLocking(configuration: Action<in DependencyLockingHandler>)

depthCompare

open override fun depthCompare(otherProject: Project): Int

evaluationDependsOn

open override fun evaluationDependsOn(path: String): Project

evaluationDependsOnChildren

open override fun evaluationDependsOnChildren()

exec

open override fun exec(closure: Closure<*>): ExecResult

open override fun exec(action: Action<in ExecSpec>): ExecResult

file

open override fun file(path: Any): File

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

files

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

open override fun files(paths: Any, configureClosure: Closure<*>): ConfigurableFileCollection

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

fileTree

open override fun fileTree(baseDir: Any): ConfigurableFileTree

open override fun fileTree(args: Map<String, *>): ConfigurableFileTree

open override fun fileTree(baseDir: Any, configureClosure: Closure<*>): ConfigurableFileTree

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

fileTree

inline fun Project.fileTree(vararg args: Pair<String, Any?>): ConfigurableFileTree

Kotlin extension function for org.gradle.api.Project.fileTree.

findProject

open override fun findProject(path: String): Project?

findProperty

open override fun findProperty(propertyName: String): Any?

getAllprojects

open override fun getAllprojects(): MutableSet<Project>

getAllTasks

open override fun getAllTasks(recursive: Boolean): MutableMap<Project, MutableSet<Task>>

getAnt

open override fun getAnt(): AntBuilder

getArtifacts

open override fun getArtifacts(): ArtifactHandler

getBuildDir

open override fun ~~getBuildDir~~(): File

getBuildFile

open override fun getBuildFile(): File

getBuildscript

open override fun getBuildscript(): ScriptHandler

The ScriptHandler for this script.

getBuildTreePath

open override fun getBuildTreePath(): String

getChildProjects

open override fun getChildProjects(): MutableMap<String, Project>

getComponents

open override fun getComponents(): SoftwareComponentContainer

getConfigurations

open override fun getConfigurations(): ConfigurationContainer

getConvention

open override fun ~~getConvention~~(): Convention

getDefaultTasks

open override fun getDefaultTasks(): MutableList<String>

getDependencies

open override fun getDependencies(): DependencyHandler

getDependencyFactory

open override fun getDependencyFactory(): DependencyFactory

getDependencyLocking

open override fun getDependencyLocking(): DependencyLockingHandler

getDepth

open override fun getDepth(): Int

getDescription

open override fun getDescription(): String?

getDisplayName

open override fun getDisplayName(): String

getExtensions

open override fun getExtensions(): ExtensionContainer

getGradle

open override fun getGradle(): Gradle

getGroup

open override fun getGroup(): Any

getLayout

open override fun getLayout(): ProjectLayout

getLogger

open override fun getLogger(): Logger

getLogging

open override fun getLogging(): LoggingManager

getName

open override fun getName(): String

getNormalization

open override fun getNormalization(): InputNormalizationHandler

getObjects

open override fun getObjects(): ObjectFactory

getParent

open override fun getParent(): Project?

getPath

open override fun getPath(): String

getPluginManager

open override fun getPluginManager(): PluginManager

getPlugins

open override fun getPlugins(): PluginContainer

getProject

open override fun getProject(): Project

getProjectDir

open override fun getProjectDir(): File

getProperties

open override fun getProperties(): MutableMap<String, *>

getProviders

open override fun getProviders(): ProviderFactory

getRepositories

open override fun getRepositories(): RepositoryHandler

getResources

open override fun getResources(): ResourceHandler

getRootDir

open override fun getRootDir(): File

getRootProject

open override fun getRootProject(): Project

getState

open override fun getState(): ProjectState

getStatus

open override fun getStatus(): Any

getSubprojects

open override fun getSubprojects(): MutableSet<Project>

getTasks

open override fun getTasks(): TaskContainer

getTasksByName

open override fun getTasksByName(name: String, recursive: Boolean): MutableSet<Task>

getVersion

open override fun getVersion(): Any

gradleKotlinDsl

fun Project.gradleKotlinDsl(): Dependency

Creates a dependency on the API of the current version of the Gradle Kotlin DSL.

hasProperty

open override fun hasProperty(propertyName: String): Boolean

javaexec

open override fun javaexec(closure: Closure<*>): ExecResult

open override fun javaexec(action: Action<in JavaExecSpec>): ExecResult

mkdir

open override fun mkdir(path: Any): File

normalization

open override fun normalization(configuration: Action<in InputNormalizationHandler>)

plugins

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

Configures the plugin dependencies for this project.

plugins

fun Project.~~plugins~~(block: PluginDependenciesSpec.() -> Unit): Nothing

Nested plugins blocks are NOT allowed, for example:

project

open override fun project(path: String): Project

open override fun project(path: String, configureClosure: Closure<*>): Project

open override fun project(path: String, configureAction: Action<in Project>): Project

property

open override fun property(propertyName: String): Any?

provideDelegate

operator fun Project.provideDelegate(any: Any?, property: KProperty<*>): PropertyDelegate

Locates a property on Project.

provider

open override fun <T : Any> provider(value: Callable<out T?>): Provider<T>

relativePath

open override fun relativePath(path: Any): String

relativeProjectPath

open override fun relativeProjectPath(path: String): String

repositories

open override fun repositories(configureClosure: Closure<*>)

repositories

fun Project.repositories(configuration: RepositoryHandler.() -> Unit)

Configures the repositories for this project.

setBuildDir

open override fun ~~setBuildDir~~(path: File)

open override fun ~~setBuildDir~~(path: Any)

setDefaultTasks

open override fun setDefaultTasks(defaultTasks: MutableList<String>)

setDescription

open override fun setDescription(description: String?)

setGroup

open override fun setGroup(group: Any)

setProperty

open override fun setProperty(name: String, value: Any?)

setStatus

open override fun setStatus(status: Any)

setVersion

open override fun setVersion(version: Any)

subprojects

open override fun subprojects(configureClosure: Closure<*>)

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

sync

open override fun sync(action: Action<in SyncSpec>): WorkResult

tarTree

open override fun tarTree(tarPath: Any): FileTree

task

open override fun task(name: String): Task

open override fun task(name: String, configureClosure: Closure<*>): Task

open override fun task(name: String, configureAction: Action<in Task>): Task

open override fun task(args: Map<String, *>, name: String): Task

open override fun task(args: Map<String, *>, name: String, configureClosure: Closure<*>): Task

task

inline fun <type : Task> Project.task(name: String): type

Creates a Task with the given name and type, and adds it to this project tasks container.

inline fun Project.task(name: String, vararg args: Pair<String, Any?>): Task

Kotlin extension function for org.gradle.api.Project.task.

inline fun <type : Task> Project.task(name: String, noinline configuration: type.() -> Unit): type

Creates a Task with the given name and type, configures it with the given configuration action, and adds it to this project tasks container.

fun <T : Task> Project.task(name: String, type: KClass<T>, configuration: T.() -> Unit): T

the

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

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

Returns the project extension of the specified type.

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.

uri

open override fun uri(path: Any): URI

zipTree

open override fun zipTree(zipPath: Any): FileTree

KotlinBuildScript

Deprecated

See also

Constructors

Properties

Functions