# Package-level declarations

The `org.gradle.kotlin.dsl` package contains the Gradle Kotlin DSL public API.

All members of this package are implicitly imported and readily available in `.gradle.kts` scripts in addition to the Gradle Java API default imports.

## Types

ArtifactHandlerScope
Link copied to clipboard
class ArtifactHandlerScope : ArtifactHandlerDelegate

Receiver for `artifacts` block providing convenient utilities for configuring artifacts.

ConfigurationContainerScope
Link copied to clipboard
class ConfigurationContainerScope : NamedDomainObjectContainerScope<Configuration> , ConfigurationContainer

Receiver for ConfigurationContainer configuration blocks.

DependencyConstraintHandlerScope
Link copied to clipboard
class DependencyConstraintHandlerScope : DependencyConstraintHandlerDelegate

Receiver for `dependencies.constraints` block providing convenient utilities for configuring dependency constraints.

DependencyHandlerScope
Link copied to clipboard
open class DependencyHandlerScope : DependencyHandlerDelegate

Receiver for `dependencies` block providing convenient utilities for configuring dependencies.

ExistingDomainObjectDelegate
Link copied to clipboard
class ExistingDomainObjectDelegate<T>

Holds a property delegate with the purpose of providing specialized implementations for the `getValue` operator based on the static type of the delegate.

ExistingDomainObjectDelegateProvider
Link copied to clipboard
class ExistingDomainObjectDelegateProvider<T>

Holds the delegate provider for the `existing` property delegate with the purpose of providing specialized implementations for the `provideDelegate` operator based on the static type of the provider.

ExistingDomainObjectDelegateProviderWithAction
Link copied to clipboard
class ExistingDomainObjectDelegateProviderWithAction<C, T>

Holds the delegate provider for the `existing` property delegate with the purpose of providing specialized implementations for the `provideDelegate` operator based on the static type of the provider.

ExistingDomainObjectDelegateProviderWithType
Link copied to clipboard
class ExistingDomainObjectDelegateProviderWithType<T, U : Any>

Holds the delegate provider and expected element type for the `existing` property delegate with the purpose of providing specialized implementations for the `provideDelegate` operator based on the static type of the provider.

ExistingDomainObjectDelegateProviderWithTypeAndAction
Link copied to clipboard
class ExistingDomainObjectDelegateProviderWithTypeAndAction<T, U : Any>

Holds the delegate provider and expected element type for the `existing` property delegate with the purpose of providing specialized implementations for the `provideDelegate` operator based on the static type of the provider.

GradleDsl
Link copied to clipboard
@DslMarker
annotation class GradleDsl

Delimits a Gradle DSL.

GroovyBuilderScope
Link copied to clipboard
interface GroovyBuilderScope : GroovyObject

Provides a dynamic dispatching DSL with Groovy semantics for better integration with plugins that rely on Groovy builders such as the core `maven` plugin.

InitialValueExtraPropertyDelegate
Link copied to clipboard
class InitialValueExtraPropertyDelegate<T>

Enables typed access to extra properties with initial value.

InitialValueExtraPropertyDelegateProvider
Link copied to clipboard
class InitialValueExtraPropertyDelegateProvider<T>

Enables typed access to extra properties with initial value.

InitScriptApi
Link copied to clipboard
abstract class InitScriptApi(val delegate: Gradle) : GradleDelegate

Standard implementation of the API exposed to all types of Gradle scripts, precompiled and otherwise.

KotlinBuildScript
Link copied to clipboard
abstract class KotlinBuildScript(host: KotlinScriptHost<Project>) : ProjectDelegate

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

KotlinClosure0
Link copied to clipboard
open class KotlinClosure0<V : Any>(val function: () -> V?, owner: Any? = null, thisObject: Any? = null) : Closure<V?>

Adapts a parameterless Kotlin function to a parameterless Groovy Closure.

KotlinClosure1
Link copied to clipboard
class KotlinClosure1<in T, V : Any>(val function: T.() -> V?, owner: Any? = null, thisObject: Any? = null) : Closure<V?>

Adapts a unary Kotlin function to a unary Groovy Closure.

KotlinClosure2
Link copied to clipboard
class KotlinClosure2<in T, in U, V : Any>(val function: (T, U) -> V?, owner: Any? = null, thisObject: Any? = null) : Closure<V?>

Adapts a binary Kotlin function to a binary Groovy Closure.

KotlinClosure3
Link copied to clipboard
class KotlinClosure3<in T, in U, in V, R : Any>(val function: (T, U, V) -> R?, owner: Any? = null, thisObject: Any? = null) : Closure<R?>

Adapts a ternary Kotlin function to a ternary Groovy Closure.

KotlinDslStandaloneScriptCompilationConfiguration
Link copied to clipboard
abstract class KotlinDslStandaloneScriptCompilationConfiguration : ScriptCompilationConfiguration

Common script compilation configuration for Kotlin DSL standalone scripts.

KotlinGradleScriptTemplate
Link copied to clipboard
abstract class KotlinGradleScriptTemplate(host: KotlinScriptHost<Gradle>) : DefaultKotlinScript, PluginAware

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

KotlinGradleScriptTemplateCompilationConfiguration
Link copied to clipboard
class KotlinGradleScriptTemplateCompilationConfiguration : KotlinDslStandaloneScriptCompilationConfiguration
KotlinInitScript
Link copied to clipboard
abstract class KotlinInitScript(host: KotlinScriptHost<Gradle>) : InitScriptApi

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

KotlinProjectScriptTemplate
Link copied to clipboard
abstract class KotlinProjectScriptTemplate(host: KotlinScriptHost<Project>) : DefaultKotlinScript

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

KotlinProjectScriptTemplateCompilationConfiguration
Link copied to clipboard
class KotlinProjectScriptTemplateCompilationConfiguration : KotlinDslStandaloneScriptCompilationConfiguration
KotlinScript
Link copied to clipboard
interface KotlinScript

Base contract for all Gradle Kotlin DSL scripts.

KotlinSettingsScript
Link copied to clipboard
abstract class KotlinSettingsScript(host: KotlinScriptHost<Settings>) : SettingsScriptApi

Legacy base class for Gradle Kotlin DSL standalone Settings scripts IDE support.

KotlinSettingsScriptTemplate
Link copied to clipboard
abstract class KotlinSettingsScriptTemplate(host: KotlinScriptHost<Settings>) : DefaultKotlinScript, PluginAware

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

KotlinSettingsScriptTemplateCompilationConfiguration
Link copied to clipboard
class KotlinSettingsScriptTemplateCompilationConfiguration : KotlinDslStandaloneScriptCompilationConfiguration
MutablePropertyDelegate
Link copied to clipboard
interface MutablePropertyDelegate : PropertyDelegate

Provides efficient access to a mutable dynamic property.

NamedDomainObjectCollectionDelegateProvider
Link copied to clipboard
class NamedDomainObjectCollectionDelegateProvider<T : Any>

Enables typed access to container elements via delegated properties.

NamedDomainObjectContainerCreatingDelegateProvider
Link copied to clipboard
class NamedDomainObjectContainerCreatingDelegateProvider<T : Any>

A property delegate that creates elements in the given NamedDomainObjectContainer.

NamedDomainObjectContainerScope
Link copied to clipboard
open class NamedDomainObjectContainerScope<T : Any> : NamedDomainObjectContainerDelegate<T> , PolymorphicDomainObjectContainer<T>

Receiver for NamedDomainObjectContainer configuration blocks.

PluginDependenciesSpecScope
Link copied to clipboard
open class PluginDependenciesSpecScope : PluginDependenciesSpec

Receiver for the `plugins` block.

PolymorphicDomainObjectContainerCreatingDelegateProvider
Link copied to clipboard
class PolymorphicDomainObjectContainerCreatingDelegateProvider<T : Any, U : T>

A property delegate that creates elements of the given type with the given configuration in the given container.

PolymorphicDomainObjectContainerGettingDelegateProvider
Link copied to clipboard
class PolymorphicDomainObjectContainerGettingDelegateProvider<T : Any, U : T>

A property delegate that gets elements of the given type from the given container and applies the given configuration.

PropertyDelegate
Link copied to clipboard
interface PropertyDelegate

Provides efficient access to a property.

RegisteringDomainObjectDelegateProvider
Link copied to clipboard
class RegisteringDomainObjectDelegateProvider<T>

Holds the delegate provider for the `registering` property delegate with the purpose of providing specialized implementations for the `provideDelegate` operator based on the static type of the provider.

RegisteringDomainObjectDelegateProviderWithAction
Link copied to clipboard
class RegisteringDomainObjectDelegateProviderWithAction<C, T>

Holds the delegate provider for the `registering` property delegate with the purpose of providing specialized implementations for the `provideDelegate` operator based on the static type of the provider.

RegisteringDomainObjectDelegateProviderWithType
Link copied to clipboard
class RegisteringDomainObjectDelegateProviderWithType<T, U : Any>

Holds the delegate provider and expected element type for the `registering` property delegate with the purpose of providing specialized implementations for the `provideDelegate` operator based on the static type of the provider.

RegisteringDomainObjectDelegateProviderWithTypeAndAction
Link copied to clipboard
class RegisteringDomainObjectDelegateProviderWithTypeAndAction<T, U : Any>

Holds the delegate provider and expected element type for the `registering` property delegate with the purpose of providing specialized implementations for the `provideDelegate` operator based on the static type of the provider.

ScriptHandlerScope
Link copied to clipboard
open class ScriptHandlerScope(delegate: ScriptHandler) : ScriptHandler

Receiver for the `buildscript` block.

SettingsScriptApi
Link copied to clipboard
abstract class SettingsScriptApi(val delegate: Settings) : SettingsDelegate

Standard implementation of the API exposed to all types of Settings scripts, precompiled and otherwise.

TaskContainerScope
Link copied to clipboard
class TaskContainerScope : TaskContainerDelegate

Receiver for the `tasks` block providing an extended set of operators for the configuration of tasks.

## Properties

antlr
Link copied to clipboard
val PluginDependenciesSpec.antlr: PluginDependencySpec
val PluginDependenciesSpec.antlr: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.antlr.AntlrPlugin.

application
Link copied to clipboard
val PluginDependenciesSpec.application: PluginDependencySpec
val PluginDependenciesSpec.application: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.ApplicationPlugin.

assembler
Link copied to clipboard
val PluginDependenciesSpec.assembler: PluginDependencySpec
val PluginDependenciesSpec.assembler: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.assembler.plugins.AssemblerPlugin.

assembler-lang
Link copied to clipboard
val PluginDependenciesSpec.assembler-lang: PluginDependencySpec
val PluginDependenciesSpec.assembler-lang: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.assembler.plugins.AssemblerLangPlugin.

base
Link copied to clipboard
val PluginDependenciesSpec.base: PluginDependencySpec
val PluginDependenciesSpec.base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.BasePlugin.

binary-base
Link copied to clipboard
val PluginDependenciesSpec.binary-base: PluginDependencySpec
val PluginDependenciesSpec.binary-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.platform.base.plugins.BinaryBasePlugin.

build-dashboard
Link copied to clipboard
val PluginDependenciesSpec.build-dashboard: PluginDependencySpec
val PluginDependenciesSpec.build-dashboard: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.reporting.plugins.BuildDashboardPlugin.

build-init
Link copied to clipboard
val PluginDependenciesSpec.build-init: PluginDependencySpec
val PluginDependenciesSpec.build-init: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.buildinit.plugins.BuildInitPlugin.

c
Link copied to clipboard
val PluginDependenciesSpec.c: PluginDependencySpec
val PluginDependenciesSpec.c: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.c.plugins.CPlugin.

c-lang
Link copied to clipboard
val PluginDependenciesSpec.c-lang: PluginDependencySpec
val PluginDependenciesSpec.c-lang: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.c.plugins.CLangPlugin.

checkstyle
Link copied to clipboard
val PluginDependenciesSpec.checkstyle: PluginDependencySpec
val PluginDependenciesSpec.checkstyle: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.quality.CheckstylePlugin.

clang-compiler
Link copied to clipboard
val PluginDependenciesSpec.clang-compiler: PluginDependencySpec
val PluginDependenciesSpec.clang-compiler: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.toolchain.plugins.ClangCompilerPlugin.

codenarc
Link copied to clipboard
val PluginDependenciesSpec.codenarc: PluginDependencySpec
val PluginDependenciesSpec.codenarc: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.quality.CodeNarcPlugin.

component-base
Link copied to clipboard
val PluginDependenciesSpec.component-base: PluginDependencySpec
val PluginDependenciesSpec.component-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.platform.base.plugins.ComponentBasePlugin.

component-model-base
Link copied to clipboard
val PluginDependenciesSpec.component-model-base: PluginDependencySpec
val PluginDependenciesSpec.component-model-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.base.plugins.ComponentModelBasePlugin.

component-reporting-tasks
Link copied to clipboard
val PluginDependenciesSpec.component-reporting-tasks: PluginDependencySpec
val PluginDependenciesSpec.component-reporting-tasks: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.internal.ComponentReportingTasksPlugin.

cpp
Link copied to clipboard
val PluginDependenciesSpec.cpp: PluginDependencySpec
val PluginDependenciesSpec.cpp: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.cpp.plugins.CppPlugin.

cpp-application
Link copied to clipboard
val PluginDependenciesSpec.cpp-application: PluginDependencySpec
val PluginDependenciesSpec.cpp-application: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.cpp.plugins.CppApplicationPlugin.

cpp-lang
Link copied to clipboard
val PluginDependenciesSpec.cpp-lang: PluginDependencySpec
val PluginDependenciesSpec.cpp-lang: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.cpp.plugins.CppLangPlugin.

cpp-library
Link copied to clipboard
val PluginDependenciesSpec.cpp-library: PluginDependencySpec
val PluginDependenciesSpec.cpp-library: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.cpp.plugins.CppLibraryPlugin.

cpp-unit-test
Link copied to clipboard
val PluginDependenciesSpec.cpp-unit-test: PluginDependencySpec
val PluginDependenciesSpec.cpp-unit-test: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.test.cpp.plugins.CppUnitTestPlugin.

creating
Link copied to clipboard
val <T : Any> NamedDomainObjectContainer<T>.creating: NamedDomainObjectContainerCreatingDelegateProvider<T>

Provides a property delegate that creates elements of the default collection type.

val TaskContainer.creating: NamedDomainObjectContainerCreatingDelegateProvider<Task>

Provides a property delegate that creates tasks of the default type.

cunit
Link copied to clipboard
val PluginDependenciesSpec.cunit: PluginDependencySpec
val PluginDependenciesSpec.cunit: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.test.cunit.plugins.CUnitConventionPlugin.

cunit-test-suite
Link copied to clipboard
val PluginDependenciesSpec.cunit-test-suite: PluginDependencySpec
val PluginDependenciesSpec.cunit-test-suite: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.test.cunit.plugins.CUnitPlugin.

distribution
Link copied to clipboard
val PluginDependenciesSpec.distribution: PluginDependencySpec
val PluginDependenciesSpec.distribution: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.distribution.plugins.DistributionPlugin.

distribution-base
Link copied to clipboard
val PluginDependenciesSpec.distribution-base: PluginDependencySpec
val PluginDependenciesSpec.distribution-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.distribution.plugins.DistributionBasePlugin.

ear
Link copied to clipboard
val PluginDependenciesSpec.ear: PluginDependencySpec
val PluginDependenciesSpec.ear: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.plugins.ear.EarPlugin.

eclipse
Link copied to clipboard
val PluginDependenciesSpec.eclipse: PluginDependencySpec
val PluginDependenciesSpec.eclipse: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.plugins.ide.eclipse.EclipsePlugin.

eclipse-wtp
Link copied to clipboard
val PluginDependenciesSpec.eclipse-wtp: PluginDependencySpec
val PluginDependenciesSpec.eclipse-wtp: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.plugins.ide.eclipse.EclipseWtpPlugin.

embedded-kotlin
Link copied to clipboard
val PluginDependenciesSpec.embedded-kotlin: PluginDependencySpec

The `embedded-kotlin` plugin.

embeddedKotlinVersion
Link copied to clipboard
val embeddedKotlinVersion: String

The version of the Kotlin compiler embedded in gradle-kotlin-dsl (currently 2.2.10).

existing
Link copied to clipboard
val <T : Any, C : NamedDomainObjectCollection<T>> C.existing: ExistingDomainObjectDelegateProvider<out C>

Idiomatic way of referring to the provider of a well-known element of a collection via a delegate property.

extra
Link copied to clipboard
val ExtensionAware.extra: ExtraPropertiesExtension

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

gcc-compiler
Link copied to clipboard
val PluginDependenciesSpec.gcc-compiler: PluginDependencySpec
val PluginDependenciesSpec.gcc-compiler: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.toolchain.plugins.GccCompilerPlugin.

getting
Link copied to clipboard
val <T : Any, U : NamedDomainObjectCollection<out T>> U.getting: NamedDomainObjectCollectionDelegateProvider<out T>

Idiomatic way of referring to an existing element in a collection via a delegate property.

google-test
Link copied to clipboard
val PluginDependenciesSpec.google-test: PluginDependencySpec
val PluginDependenciesSpec.google-test: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.test.googletest.plugins.GoogleTestConventionPlugin.

google-test-test-suite
Link copied to clipboard
val PluginDependenciesSpec.google-test-test-suite: PluginDependencySpec
val PluginDependenciesSpec.google-test-test-suite: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.test.googletest.plugins.GoogleTestPlugin.

groovy
Link copied to clipboard
val PluginDependenciesSpec.groovy: PluginDependencySpec
val PluginDependenciesSpec.groovy: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.GroovyPlugin.

groovy-base
Link copied to clipboard
val PluginDependenciesSpec.groovy-base: PluginDependencySpec
val PluginDependenciesSpec.groovy-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.GroovyBasePlugin.

groovy-gradle-plugin
Link copied to clipboard
val PluginDependenciesSpec.groovy-gradle-plugin: PluginDependencySpec
val PluginDependenciesSpec.groovy-gradle-plugin: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.plugin.devel.internal.precompiled.PrecompiledGroovyPluginsPlugin.

help-tasks
Link copied to clipboard
val PluginDependenciesSpec.help-tasks: PluginDependencySpec
val PluginDependenciesSpec.help-tasks: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.HelpTasksPlugin.

idea
Link copied to clipboard
val PluginDependenciesSpec.idea: PluginDependencySpec
val PluginDependenciesSpec.idea: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.plugins.ide.idea.IdeaPlugin.

ivy-publish
Link copied to clipboard
val PluginDependenciesSpec.ivy-publish: PluginDependencySpec
val PluginDependenciesSpec.ivy-publish: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.publish.ivy.plugins.IvyPublishPlugin.

jacoco
Link copied to clipboard
val PluginDependenciesSpec.jacoco: PluginDependencySpec
val PluginDependenciesSpec.jacoco: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.testing.jacoco.plugins.JacocoPlugin.

jacoco-report-aggregation
Link copied to clipboard
val PluginDependenciesSpec.jacoco-report-aggregation: PluginDependencySpec
val PluginDependenciesSpec.jacoco-report-aggregation: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.testing.jacoco.plugins.JacocoReportAggregationPlugin.

java
Link copied to clipboard
val PluginDependenciesSpec.java: PluginDependencySpec
val PluginDependenciesSpec.java: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JavaPlugin.

java-base
Link copied to clipboard
val PluginDependenciesSpec.java-base: PluginDependencySpec
val PluginDependenciesSpec.java-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JavaBasePlugin.

java-gradle-plugin
Link copied to clipboard
val PluginDependenciesSpec.java-gradle-plugin: PluginDependencySpec
val PluginDependenciesSpec.java-gradle-plugin: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.plugin.devel.plugins.JavaGradlePluginPlugin.

java-library
Link copied to clipboard
val PluginDependenciesSpec.java-library: PluginDependencySpec
val PluginDependenciesSpec.java-library: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JavaLibraryPlugin.

java-library-distribution
Link copied to clipboard
val PluginDependenciesSpec.java-library-distribution: PluginDependencySpec
val PluginDependenciesSpec.java-library-distribution: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JavaLibraryDistributionPlugin.

java-platform
Link copied to clipboard
val PluginDependenciesSpec.java-platform: PluginDependencySpec
val PluginDependenciesSpec.java-platform: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JavaPlatformPlugin.

java-test-fixtures
Link copied to clipboard
val PluginDependenciesSpec.java-test-fixtures: PluginDependencySpec
val PluginDependenciesSpec.java-test-fixtures: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JavaTestFixturesPlugin.

jvm
Link copied to clipboard
@get:Incubating
val ToolchainManagement.jvm: JvmToolchainManagement

Provides statically defined accessors for getting the "jvm" block of "toolchainManagement". The "jvm-toolchain-management" plugin needs to be applied in order for these extensions to work.

jvm-ecosystem
Link copied to clipboard
val PluginDependenciesSpec.jvm-ecosystem: PluginDependencySpec
val PluginDependenciesSpec.jvm-ecosystem: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JvmEcosystemPlugin.

jvm-test-suite
Link copied to clipboard
val PluginDependenciesSpec.jvm-test-suite: PluginDependencySpec
val PluginDependenciesSpec.jvm-test-suite: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JvmTestSuitePlugin.

jvm-toolchain-management
Link copied to clipboard
val PluginDependenciesSpec.jvm-toolchain-management: PluginDependencySpec
val PluginDependenciesSpec.jvm-toolchain-management: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JvmToolchainManagementPlugin.

jvm-toolchains
Link copied to clipboard
val PluginDependenciesSpec.jvm-toolchains: PluginDependencySpec
val PluginDependenciesSpec.jvm-toolchains: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.JvmToolchainsPlugin.

kotlin-dsl
Link copied to clipboard
val PluginDependenciesSpec.kotlin-dsl: PluginDependencySpec

The `kotlin-dsl` plugin.

kotlin-dsl-base
Link copied to clipboard
val PluginDependenciesSpec.kotlin-dsl-base: PluginDependencySpec

The `kotlin-dsl.base` plugin.

kotlin-dsl-precompiled-script-plugins
Link copied to clipboard
val PluginDependenciesSpec.kotlin-dsl-precompiled-script-plugins: PluginDependencySpec

The `kotlin-dsl.precompiled-script-plugins` plugin.

language-base
Link copied to clipboard
val PluginDependenciesSpec.language-base: PluginDependencySpec
val PluginDependenciesSpec.language-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.base.plugins.LanguageBasePlugin.

lifecycle-base
Link copied to clipboard
val PluginDependenciesSpec.lifecycle-base: PluginDependencySpec
val PluginDependenciesSpec.lifecycle-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.base.plugins.LifecycleBasePlugin.

maven-publish
Link copied to clipboard
val PluginDependenciesSpec.maven-publish: PluginDependencySpec
val PluginDependenciesSpec.maven-publish: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.publish.maven.plugins.MavenPublishPlugin.

microsoft-visual-cpp-compiler
Link copied to clipboard
val PluginDependenciesSpec.microsoft-visual-cpp-compiler: PluginDependencySpec
val PluginDependenciesSpec.microsoft-visual-cpp-compiler: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.toolchain.plugins.MicrosoftVisualCppCompilerPlugin.

model-reporting-tasks
Link copied to clipboard
val PluginDependenciesSpec.model-reporting-tasks: PluginDependencySpec
val PluginDependenciesSpec.model-reporting-tasks: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.internal.ModelReportingTasksPlugin.

native-component
Link copied to clipboard
val PluginDependenciesSpec.native-component: PluginDependencySpec
val PluginDependenciesSpec.native-component: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.plugins.NativeComponentPlugin.

native-component-model
Link copied to clipboard
val PluginDependenciesSpec.native-component-model: PluginDependencySpec
val PluginDependenciesSpec.native-component-model: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.plugins.NativeComponentModelPlugin.

objective-c
Link copied to clipboard
val PluginDependenciesSpec.objective-c: PluginDependencySpec
val PluginDependenciesSpec.objective-c: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.objectivec.plugins.ObjectiveCPlugin.

objective-c-lang
Link copied to clipboard
val PluginDependenciesSpec.objective-c-lang: PluginDependencySpec
val PluginDependenciesSpec.objective-c-lang: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.objectivec.plugins.ObjectiveCLangPlugin.

objective-cpp
Link copied to clipboard
val PluginDependenciesSpec.objective-cpp: PluginDependencySpec
val PluginDependenciesSpec.objective-cpp: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.objectivecpp.plugins.ObjectiveCppPlugin.

objective-cpp-lang
Link copied to clipboard
val PluginDependenciesSpec.objective-cpp-lang: PluginDependencySpec
val PluginDependenciesSpec.objective-cpp-lang: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.objectivecpp.plugins.ObjectiveCppLangPlugin.

pmd
Link copied to clipboard
val PluginDependenciesSpec.pmd: PluginDependencySpec
val PluginDependenciesSpec.pmd: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.quality.PmdPlugin.

project-report
Link copied to clipboard
val PluginDependenciesSpec.project-report: PluginDependencySpec
val PluginDependenciesSpec.project-report: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.ProjectReportsPlugin.

project-reports
Link copied to clipboard
val PluginDependenciesSpec.project-reports: PluginDependencySpec
val PluginDependenciesSpec.project-reports: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.ProjectReportsPlugin.

publishing
Link copied to clipboard
val PluginDependenciesSpec.publishing: PluginDependencySpec
val PluginDependenciesSpec.publishing: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.publish.plugins.PublishingPlugin.

registering
Link copied to clipboard
val <T : Any, C : NamedDomainObjectContainer<T>> C.registering: RegisteringDomainObjectDelegateProvider<out C>

Property delegate for registering new elements in the container.

reporting-base
Link copied to clipboard
val PluginDependenciesSpec.reporting-base: PluginDependencySpec
val PluginDependenciesSpec.reporting-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.ReportingBasePlugin.

scala
Link copied to clipboard
val PluginDependenciesSpec.scala: PluginDependencySpec
val PluginDependenciesSpec.scala: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.scala.ScalaPlugin.

scala-base
Link copied to clipboard
val PluginDependenciesSpec.scala-base: PluginDependencySpec
val PluginDependenciesSpec.scala-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.scala.ScalaBasePlugin.

signing
Link copied to clipboard
val PluginDependenciesSpec.signing: PluginDependencySpec
val PluginDependenciesSpec.signing: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.plugins.signing.SigningPlugin.

software-reporting-tasks
Link copied to clipboard
val PluginDependenciesSpec.software-reporting-tasks: PluginDependencySpec
val PluginDependenciesSpec.software-reporting-tasks: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.SoftwareReportingTasksPlugin.

standard-tool-chains
Link copied to clipboard
val PluginDependenciesSpec.standard-tool-chains: PluginDependencySpec
val PluginDependenciesSpec.standard-tool-chains: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.toolchain.internal.plugins.StandardToolChainsPlugin.

swift-application
Link copied to clipboard
val PluginDependenciesSpec.swift-application: PluginDependencySpec
val PluginDependenciesSpec.swift-application: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.swift.plugins.SwiftApplicationPlugin.

swift-library
Link copied to clipboard
val PluginDependenciesSpec.swift-library: PluginDependencySpec
val PluginDependenciesSpec.swift-library: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.swift.plugins.SwiftLibraryPlugin.

swiftpm-export
Link copied to clipboard
val PluginDependenciesSpec.swiftpm-export: PluginDependencySpec
val PluginDependenciesSpec.swiftpm-export: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.swiftpm.plugins.SwiftPackageManagerExportPlugin.

test-report-aggregation
Link copied to clipboard
val PluginDependenciesSpec.test-report-aggregation: PluginDependencySpec
val PluginDependenciesSpec.test-report-aggregation: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.TestReportAggregationPlugin.

test-suite-base
Link copied to clipboard
val PluginDependenciesSpec.test-suite-base: PluginDependencySpec
val PluginDependenciesSpec.test-suite-base: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.testing.base.plugins.TestSuiteBasePlugin.

version-catalog
Link copied to clipboard
val PluginDependenciesSpec.version-catalog: PluginDependencySpec
val PluginDependenciesSpec.version-catalog: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.catalog.VersionCatalogPlugin.

visual-studio
Link copied to clipboard
val PluginDependenciesSpec.visual-studio: PluginDependencySpec
val PluginDependenciesSpec.visual-studio: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.ide.visualstudio.plugins.VisualStudioPlugin.

war
Link copied to clipboard
val PluginDependenciesSpec.war: PluginDependencySpec
val PluginDependenciesSpec.war: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.api.plugins.WarPlugin.

windows-resource-script
Link copied to clipboard
val PluginDependenciesSpec.windows-resource-script: PluginDependencySpec
val PluginDependenciesSpec.windows-resource-script: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.rc.plugins.WindowsResourceScriptPlugin.

windows-resources
Link copied to clipboard
val PluginDependenciesSpec.windows-resources: PluginDependencySpec
val PluginDependenciesSpec.windows-resources: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.language.rc.plugins.WindowsResourcesPlugin.

wrapper
Link copied to clipboard
val PluginDependenciesSpec.wrapper: PluginDependencySpec
val PluginDependenciesSpec.wrapper: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.buildinit.plugins.WrapperPlugin.

xcode
Link copied to clipboard
val PluginDependenciesSpec.xcode: PluginDependencySpec
val PluginDependenciesSpec.xcode: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.ide.xcode.plugins.XcodePlugin.

xctest
Link copied to clipboard
val PluginDependenciesSpec.xctest: PluginDependencySpec
val PluginDependenciesSpec.xctest: PluginDependencySpec

The builtin Gradle plugin implemented by org.gradle.nativeplatform.test.xctest.plugins.XCTestConventionPlugin.

## Functions

add
Link copied to clipboard
inline fun <T : Any> CompatibilityRuleChain<T>.add(ruleClass: KClass<out AttributeCompatibilityRule<T>>)
inline fun <T : Any> CompatibilityRuleChain<T>.add(rule: KClass<out AttributeCompatibilityRule<T>>)
inline fun <T : Any> CompatibilityRuleChain<T>.add(ruleClass: KClass<out AttributeCompatibilityRule<T>>, configureAction: Action<in ActionConfiguration>)
inline fun <T : Any> CompatibilityRuleChain<T>.add(rule: KClass<out AttributeCompatibilityRule<T>>, configureAction: Action<in ActionConfiguration>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.attributes.CompatibilityRuleChain.add.

inline fun <T : Any> DisambiguationRuleChain<T>.add(ruleClass: KClass<out AttributeDisambiguationRule<T>>)
inline fun <T : Any> DisambiguationRuleChain<T>.add(rule: KClass<out AttributeDisambiguationRule<T>>)
inline fun <T : Any> DisambiguationRuleChain<T>.add(ruleClass: KClass<out AttributeDisambiguationRule<T>>, configureAction: Action<in ActionConfiguration>)
inline fun <T : Any> DisambiguationRuleChain<T>.add(rule: KClass<out AttributeDisambiguationRule<T>>, configureAction: Action<in ActionConfiguration>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.attributes.DisambiguationRuleChain.add.

inline fun <T : Any> ExtensionContainer.add(name: String, extension: T)

Adds a new extension to this container.

inline fun <T : ModuleDependency> DependencyHandler.add(configuration: String, dependency: T, dependencyConfiguration: T.() -> Unit): T
inline fun DependencyHandler.add(configuration: String, dependencyNotation: String, dependencyConfiguration: ExternalModuleDependency.() -> Unit): ExternalModuleDependency

Adds a dependency to the given configuration, and configures the dependency using the given expression.

@Incubating
inline fun <T : Any> SharedModelDefaults.add(name: String, publicType: KClass<T>, configureAction: Action<in T>)
@Incubating
inline fun <T : Any> SharedModelDefaults.add(name: String, publicType: KClass<T>, configureAction: Action<in T>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.initialization.SharedModelDefaults.add.

inline fun <T : Any> ExtensionContainer.add(publicType: KClass<T>, name: String, extension: T)
inline fun <T : Any> ExtensionContainer.add(publicType: KClass<T>, name: String, extension: T)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.ExtensionContainer.add.

additionalData
Link copied to clipboard
@Incubating
inline fun <T : AdditionalData> ProblemSpec.additionalData(type: KClass<T>, config: Action<in T>): ProblemSpec
@Incubating
inline fun <T : AdditionalData> ProblemSpec.additionalData(type: KClass<T>, config: Action<in T>): ProblemSpec

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.problems.ProblemSpec.additionalData.

afterEach
Link copied to clipboard
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.afterEach(type: KClass<S>, configAction: Action<in S>)
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.afterEach(type: KClass<S>, configAction: Action<in S>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.model.ModelMap.afterEach.

all
Link copied to clipboard
inline fun <T : ComponentMetadataRule> ComponentMetadataHandler.all(): ComponentMetadataHandler

Adds a class based rule that may modify the metadata of any resolved software component.

inline fun ComponentMetadataHandler.all(rule: KClass<out ComponentMetadataRule>): ComponentMetadataHandler
inline fun ComponentMetadataHandler.all(rule: KClass<out ComponentMetadataRule>): ComponentMetadataHandler
inline fun ComponentMetadataHandler.all(rule: KClass<out ComponentMetadataRule>, configureAction: Action<in ActionConfiguration>): ComponentMetadataHandler
inline fun ComponentMetadataHandler.all(rule: KClass<out ComponentMetadataRule>, configureAction: Action<in ActionConfiguration>): ComponentMetadataHandler

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.dsl.ComponentMetadataHandler.all.

inline fun <T : ComponentMetadataRule> ComponentMetadataHandler.all(configureAction: Action<in ActionConfiguration>): ComponentMetadataHandler

Adds a class based rule that may modify the metadata of any resolved software component. The rule itself is configured by the provided configure action.

always
Link copied to clipboard
@Incubating
inline fun <P : FlowParameters> FlowScope.always(action: KClass<out FlowAction<P>>, configure: Action<in FlowActionSpec<P>>): FlowScope.Registration<P>
@Incubating
inline fun <P : FlowParameters> FlowScope.always(action: KClass<out FlowAction<P>>, configure: Action<in FlowActionSpec<P>>): FlowScope.Registration<P>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.flow.FlowScope.always.

apply
Link copied to clipboard
inline fun <T : Plugin<Project>> Project.apply()
inline fun <T : Plugin<Settings>> Settings.apply()
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 Script.apply(vararg options: Pair<String, Any>)
inline fun Script.apply(vararg options: Pair<String, Any>)

Kotlin extension function for org.gradle.api.Script.apply.

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

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

inline fun <T : Plugin<*>> PluginContainer.apply(type: KClass<T>): T
inline fun <T : Plugin<*>> PluginContainer.apply(type: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.apply.

inline fun PluginManager.apply(type: KClass<*>)
inline fun PluginManager.apply(type: KClass<*>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginManager.apply.

infix fun PluginDependencySpec.apply(apply: Boolean): PluginDependencySpec

Specifies whether the plugin should be applied to the current project. Otherwise it is only put on the project's classpath.

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

Applies the given plugin or script.

applyTo
Link copied to clipboard
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
Link copied to clipboard
fun Project.artifacts(configuration: ArtifactHandlerScope.() -> Unit)

Configures the artifacts for this project.

assign
Link copied to clipboard
fun ConfigurableFileCollection.assign(fileCollection: FileCollection)

Sets the ConfigurableFileCollection to contain the source paths of passed collection. This is the same as calling ConfigurableFileCollection.setFrom(fileCollection: FileCollection).

fun <T : FileSystemLocation> FileSystemLocationProperty<T>.assign(file: File?)

Assign file to a FileSystemLocationProperty with assign operator

fun <T : FileSystemLocation> FileSystemLocationProperty<T>.assign(provider: Provider<File>)

Assign file provided by a Provider to a FileSystemLocationProperty with assign operator

fun <T : Any> HasMultipleValues<T>.assign(elements: Iterable<T>?)

Sets the value of the property to the elements of the given iterable, and replaces any existing value

fun <T : Any> HasMultipleValues<T>.assign(provider: Provider<out Iterable<T>>)
fun <K : Any, V : Any> MapProperty<K, V>.assign(provider: Provider<out Map<out K, V>>)

Sets the property to have the same value of the given provider, and replaces any existing value

fun <K : Any, V : Any> MapProperty<K, V>.assign(entries: Map<out K, V>?)

Sets the value of this property to the entries of the given Map, and replaces any existing value

fun <T : Any> Property<T>.assign(value: T?)

Assign value: T to a property with assign operator

fun <T : Any> Property<T>.assign(value: Provider<out T>)

Assign value: Provider to a property with assign operator

attributes
Link copied to clipboard
inline fun Manifest.attributes(vararg attributes: Pair<String, Any>): Manifest
inline fun Manifest.attributes(vararg attributes: Pair<String, Any>): Manifest
inline fun Manifest.attributes(sectionName: String, vararg attributes: Pair<String, Any>): Manifest
inline fun Manifest.attributes(sectionName: String, vararg attributes: Pair<String, Any>): Manifest

Kotlin extension function for org.gradle.api.java.archives.Manifest.attributes.

beforeEach
Link copied to clipboard
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.beforeEach(type: KClass<S>, configAction: Action<in S>)
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.beforeEach(type: KClass<S>, configAction: Action<in S>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.model.ModelMap.beforeEach.

buildscript
Link copied to clipboard
fun Project.buildscript(action: ScriptHandlerScope.() -> Unit)

Configures the build script classpath for this project.

closureOf
Link copied to clipboard
fun <T> Any.closureOf(action: T.() -> Unit): Closure<Any?>

Adapts a Kotlin function to a single argument Groovy Closure.

configure
Link copied to clipboard
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.

inline fun <T : Any> ExtensionContainer.configure(noinline action: T.() -> Unit)

Looks for the extension of the specified type and configures it with the supplied action.

inline fun <T : Any> ExtensionContainer.configure(type: KClass<T>, action: Action<in T>)
inline fun <T : Any> ExtensionContainer.configure(type: KClass<T>, action: Action<in T>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.ExtensionContainer.configure.

configureEach
Link copied to clipboard
inline fun <S : Any, T : SoftwareComponent> BinaryCollection<T>.configureEach(type: KClass<S>, action: Action<in S>)
inline fun <S : Any, T : SoftwareComponent> BinaryCollection<T>.configureEach(type: KClass<S>, action: Action<in S>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.language.BinaryCollection.configureEach.

container
Link copied to clipboard
inline fun <T : Any> 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>): NamedDomainObjectContainer<T>
inline fun <T : Any> Project.container(type: KClass<T>, factory: NamedDomainObjectFactory<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.

containerWithType
Link copied to clipboard
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.containerWithType(type: KClass<U>): NamedDomainObjectContainer<U>
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.containerWithType(type: KClass<U>): NamedDomainObjectContainer<U>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.PolymorphicDomainObjectContainer.containerWithType.

create
Link copied to clipboard
inline fun <U : Any> PolymorphicDomainObjectContainer<in U>.create(name: String): <Error class: unknown class>

Creates a domain object with the specified name and type, and adds it to the container.

inline fun TaskContainer.create(vararg options: Pair<String, Any>): Task
inline fun TaskContainer.create(vararg options: Pair<String, Any>): Task

Kotlin extension function for org.gradle.api.tasks.TaskContainer.create.

inline fun <U : Any> PolymorphicDomainObjectContainer<in U>.create(name: String, noinline configuration: U.() -> Unit): U

Creates a domain object with the specified name and type, adds it to the container, and configures it with the specified action.

inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.create(name: String, type: KClass<U>): U
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.create(name: String, type: KClass<U>): U
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.create(name: String, type: KClass<U>, configuration: Action<in U>): U
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.create(name: String, type: KClass<U>, configuration: Action<in U>): U

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.PolymorphicDomainObjectContainer.create.

inline fun DependencyHandler.create(dependencyNotation: String, dependencyConfiguration: ExternalModuleDependency.() -> Unit): ExternalModuleDependency

Creates a dependency without adding it to a configuration.

inline fun <T : Any> ExtensionContainer.create(name: String, vararg constructionArguments: Any): T

Creates and adds a new extension to this container.

inline fun <T : Task> TaskContainer.create(name: String, vararg arguments: Any): T

Creates a Task with the given name and type, passing the given arguments to the javax.inject.Inject-annotated constructor, and adds it to this project tasks container.

inline fun <T : Task> TaskContainer.create(name: String, noinline configureAction: T.() -> Unit): T

Creates a Task with the specified name and type, adds it to the container, and configures it with the specified action.

inline fun <T : Task> TaskContainer.create(name: String, type: KClass<T>): T
inline fun <T : Task> TaskContainer.create(name: String, type: KClass<T>): T
inline fun <T : Task> TaskContainer.create(name: String, type: KClass<T>, vararg constructorArgs: Any): T
inline fun <T : Task> TaskContainer.create(name: String, type: KClass<T>, vararg constructorArgs: Any): T
inline fun <T : Task> TaskContainer.create(name: String, type: KClass<T>, configuration: Action<in T>): T
inline fun <T : Task> TaskContainer.create(name: String, type: KClass<T>, configuration: Action<in T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.TaskContainer.create.

@Incubating
inline fun <S : T, T : Any> ModelMap<T>.create(name: String, type: KClass<S>)
@Incubating
inline fun <S : T, T : Any> ModelMap<T>.create(name: String, type: KClass<S>)
@Incubating
inline fun <S : T, T : Any> ModelMap<T>.create(name: String, type: KClass<S>, configAction: Action<in S>)
@Incubating
inline fun <S : T, T : Any> ModelMap<T>.create(name: String, type: KClass<S>, configAction: Action<in S>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.model.ModelMap.create.

inline fun <T : Any> ExtensionContainer.create(name: String, type: KClass<T>, vararg constructionArguments: Any): T
inline fun <T : Any> ExtensionContainer.create(name: String, type: KClass<T>, vararg constructionArguments: Any): T
inline fun <T : Any> ExtensionContainer.create(publicType: KClass<T>, name: String, instanceType: KClass<out T>, vararg constructionArguments: Any): T
inline fun <T : Any> ExtensionContainer.create(publicType: KClass<T>, name: String, instanceType: KClass<out T>, vararg constructionArguments: Any): T
inline fun <T : Any> ExtensionContainer.create(publicType: TypeOf<T>, name: String, instanceType: KClass<out T>, vararg constructionArguments: Any): T
inline fun <T : Any> ExtensionContainer.create(publicType: TypeOf<T>, name: String, instanceType: KClass<out T>, vararg constructionArguments: Any): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.ExtensionContainer.create.

@Incubating
inline fun <T : Task> BinaryTasksCollection.create(name: String, type: KClass<T>, config: Action<in T>)
@Incubating
inline fun <T : Task> BinaryTasksCollection.create(name: String, type: KClass<T>, config: Action<in T>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.platform.base.BinaryTasksCollection.create.

fun DependencyHandler.create(group: String, name: String, version: String? = null, configuration: String? = null, classifier: String? = null, ext: String? = null): ExternalModuleDependency

Creates a dependency on a module without adding it to a configuration.

creating
Link copied to clipboard
fun <T : Any> NamedDomainObjectContainer<T>.creating(configuration: T.() -> Unit): NamedDomainObjectContainerCreatingDelegateProvider<T>

Provides a property delegate that creates elements of the default collection type with the given configuration.

fun <T : Any, U : T> PolymorphicDomainObjectContainer<T>.creating(type: KClass<U>): PolymorphicDomainObjectContainerCreatingDelegateProvider<T, T>

Provides a property delegate that creates elements of the given type.

fun TaskContainer.creating(configuration: Task.() -> Unit): NamedDomainObjectContainerCreatingDelegateProvider<Task>

Provides a property delegate that creates tasks of the default type with the given configuration.

fun <U : Task> TaskContainer.creating(type: KClass<U>): PolymorphicDomainObjectContainerCreatingDelegateProvider<Task, Task>

Provides a property delegate that creates tasks of the given type.

fun <T : Any, U : T> PolymorphicDomainObjectContainer<T>.creating(type: Class<U>, configuration: U.() -> Unit): PolymorphicDomainObjectContainerCreatingDelegateProvider<T, U>

Provides a property delegate that creates elements of the given type expressed as a java.lang.Class with the given configuration.

fun <T : Any, U : T> PolymorphicDomainObjectContainer<T>.creating(type: KClass<U>, configuration: U.() -> Unit): <Error class: unknown class>

Provides a property delegate that creates elements of the given type with the given configuration.

fun <U : Task> TaskContainer.creating(type: Class<U>, configuration: U.() -> Unit): PolymorphicDomainObjectContainerCreatingDelegateProvider<Task, U>

Provides a property delegate that creates tasks of the given type expressed as a java.lang.Class with the given configuration.

fun <U : Task> TaskContainer.creating(type: KClass<U>, configuration: U.() -> Unit): <Error class: unknown class>

Provides a property delegate that creates tasks of the given type with the given configuration.

credentials
Link copied to clipboard
inline fun AuthenticationSupported.credentials(credentialsType: KClass<out Credentials>)
inline fun AuthenticationSupported.credentials(credentialsType: KClass<out Credentials>)
inline fun <T : Credentials> AuthenticationSupported.credentials(credentialsType: KClass<T>, action: Action<in T>)
inline fun <T : Credentials> AuthenticationSupported.credentials(credentialsType: KClass<T>, action: Action<in T>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.repositories.AuthenticationSupported.credentials.

inline fun <T : Credentials> ProviderFactory.credentials(credentialsType: KClass<T>, identity: String): Provider<T>
inline fun <T : Credentials> ProviderFactory.credentials(credentialsType: KClass<T>, identity: String): Provider<T>
inline fun <T : Credentials> ProviderFactory.credentials(credentialsType: KClass<T>, identity: Provider<String>): Provider<T>
inline fun <T : Credentials> ProviderFactory.credentials(credentialsType: KClass<T>, identity: Provider<String>): Provider<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.provider.ProviderFactory.credentials.

defaultImplementation
Link copied to clipboard
@Incubating
inline fun <T : Any> TypeBuilder<T>.defaultImplementation(implementation: KClass<*>): TypeBuilder<T>
@Incubating
inline fun <T : Any> TypeBuilder<T>.defaultImplementation(implementation: KClass<*>): TypeBuilder<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.platform.base.TypeBuilder.defaultImplementation.

defaultTasks
Link copied to clipboard
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.

delegateClosureOf
Link copied to clipboard
fun <T> Any.delegateClosureOf(action: T.() -> Unit): Closure<Unit>

Adapts a Kotlin function to a Groovy Closure that operates on the configured Closure delegate.

dependencies
Link copied to clipboard
fun Project.dependencies(configuration: DependencyHandlerScope.() -> Unit)

Configures the dependencies for this project.

dependencyLocking
Link copied to clipboard
fun ScriptHandler.dependencyLocking(configuration: DependencyLockingHandler.() -> Unit)

Configures the dependency locking for the script dependency configurations.

dir
Link copied to clipboard
inline fun SourceSetOutput.dir(dir: Any, vararg options: Pair<String, Any>)
inline fun SourceSetOutput.dir(dir: Any, vararg options: Pair<String, Any>)

Kotlin extension function for org.gradle.api.tasks.SourceSetOutput.dir.

domainObjectContainer
Link copied to clipboard
inline fun <T : Any> ObjectFactory.domainObjectContainer(elementType: KClass<T>): NamedDomainObjectContainer<T>
inline fun <T : Any> ObjectFactory.domainObjectContainer(elementType: KClass<T>): NamedDomainObjectContainer<T>
inline fun <T : Any> ObjectFactory.domainObjectContainer(elementType: KClass<T>, factory: NamedDomainObjectFactory<T>): NamedDomainObjectContainer<T>
inline fun <T : Any> ObjectFactory.domainObjectContainer(elementType: KClass<T>, factory: NamedDomainObjectFactory<T>): NamedDomainObjectContainer<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.domainObjectContainer.

domainObjectSet
Link copied to clipboard
inline fun <T : Any> ObjectFactory.domainObjectSet(elementType: KClass<T>): DomainObjectSet<T>
inline fun <T : Any> ObjectFactory.domainObjectSet(elementType: KClass<T>): DomainObjectSet<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.domainObjectSet.

embeddedKotlin
Link copied to clipboard
fun DependencyHandler.embeddedKotlin(module: String): Any

Builds the dependency notation for the named Kotlin module at the embedded version (currently 2.2.10).

fun PluginDependenciesSpec.embeddedKotlin(module: String): PluginDependencySpec

Applies the given Kotlin plugin module at the embedded version (currently 2.2.10).

environment
Link copied to clipboard
inline fun <T : AbstractExecTask<*>> AbstractExecTask<T>.environment(vararg environmentVariables: Pair<String, Any>): T
inline fun <T : AbstractExecTask<*>> AbstractExecTask<T>.environment(vararg environmentVariables: Pair<String, Any>): T

Kotlin extension function for org.gradle.api.tasks.AbstractExecTask.environment.

inline fun JavaExec.environment(vararg environmentVariables: Pair<String, Any>): JavaExec
inline fun JavaExec.environment(vararg environmentVariables: Pair<String, Any>): JavaExec

Kotlin extension function for org.gradle.api.tasks.JavaExec.environment.

inline fun Test.environment(vararg environmentVariables: Pair<String, Any>): Test
inline fun Test.environment(vararg environmentVariables: Pair<String, Any>): Test

Kotlin extension function for org.gradle.api.tasks.testing.Test.environment.

inline fun ProcessForkOptions.environment(vararg environmentVariables: Pair<String, Any>): ProcessForkOptions
inline fun ProcessForkOptions.environment(vararg environmentVariables: Pair<String, Any>): ProcessForkOptions

Kotlin extension function for org.gradle.process.ProcessForkOptions.environment.

exclude
Link copied to clipboard
fun <T : ModuleDependency> T.exclude(group: String? = null, module: String? = null): T

Adds an exclude rule to exclude transitive dependencies of this dependency.

fun Configuration.exclude(group: String? = null, module: String? = null): Configuration

Adds an exclude rule to exclude transitive dependencies for all dependencies of this configuration. You can also add exclude rules per-dependency. See ModuleDependency.exclude.

existing
Link copied to clipboard
fun <T : Any, C : NamedDomainObjectCollection<T>> C.existing(action: T.() -> Unit): ExistingDomainObjectDelegateProviderWithAction<out C, T>
fun <T : Any, C : NamedDomainObjectCollection<T>, U : T> C.existing(type: KClass<U>): ExistingDomainObjectDelegateProviderWithType<out C, U>
fun <T : Any, C : NamedDomainObjectCollection<T>, U : T> C.existing(type: KClass<U>, action: U.() -> Unit): ExistingDomainObjectDelegateProviderWithTypeAndAction<out C, U>

Idiomatic way of referring to the provider of a well-known element of a collection via a delegate property.

expand
Link copied to clipboard
inline fun ContentFilterable.expand(vararg properties: Pair<String, Any>): ContentFilterable
inline fun ContentFilterable.expand(vararg properties: Pair<String, Any>): ContentFilterable
inline fun ContentFilterable.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): ContentFilterable
inline fun ContentFilterable.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): ContentFilterable

Kotlin extension function for org.gradle.api.file.ContentFilterable.expand.

inline fun CopySpec.expand(vararg properties: Pair<String, Any>): CopySpec
inline fun CopySpec.expand(vararg properties: Pair<String, Any>): CopySpec
inline fun CopySpec.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): CopySpec
inline fun CopySpec.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): CopySpec

Kotlin extension function for org.gradle.api.file.CopySpec.expand.

inline fun AbstractCopyTask.expand(vararg properties: Pair<String, Any>): AbstractCopyTask
inline fun AbstractCopyTask.expand(vararg properties: Pair<String, Any>): AbstractCopyTask
inline fun AbstractCopyTask.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): AbstractCopyTask
inline fun AbstractCopyTask.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): AbstractCopyTask

Kotlin extension function for org.gradle.api.tasks.AbstractCopyTask.expand.

facet
Link copied to clipboard
inline fun EclipseWtpFacet.facet(vararg args: Pair<String, Any>)
inline fun EclipseWtpFacet.facet(vararg args: Pair<String, Any>)

Kotlin extension function for org.gradle.plugins.ide.eclipse.model.EclipseWtpFacet.facet.

fileTree
Link copied to clipboard
inline fun Project.fileTree(vararg args: Pair<String, Any>): ConfigurableFileTree
inline fun Project.fileTree(vararg args: Pair<String, Any>): ConfigurableFileTree

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

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

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

filter
Link copied to clipboard
inline fun <T : FilterReader> ContentFilterable.filter(vararg properties: Pair<String, Any?>): ContentFilterable
inline fun <T : FilterReader> ContentFilterable.filter(properties: Map<String, Any?>): ContentFilterable
fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, vararg properties: Pair<String, Any?>): ContentFilterable
fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, properties: Map<String, Any?>): ContentFilterable

Adds a content filter to be used during the copy. Multiple calls add additional filters to the filter chain. Each filter should implement FilterReader. Import `org.apache.tools.ant.filters.*` for access to all the standard Ant filters.

inline fun ContentFilterable.filter(filterType: KClass<out FilterReader>): ContentFilterable
inline fun ContentFilterable.filter(filterType: KClass<out FilterReader>): ContentFilterable
inline fun ContentFilterable.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): ContentFilterable
inline fun ContentFilterable.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): ContentFilterable

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.file.ContentFilterable.filter.

inline fun <T : FilterReader> CopySpec.filter(vararg properties: Pair<String, Any?>): CopySpec
inline fun <T : FilterReader> CopySpec.filter(properties: Map<String, Any?>): CopySpec

Adds a content filter to be used during the copy.

inline fun CopySpec.filter(filterType: KClass<out FilterReader>): CopySpec
inline fun CopySpec.filter(filterType: KClass<out FilterReader>): CopySpec
inline fun CopySpec.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): CopySpec
inline fun CopySpec.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): CopySpec

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.file.CopySpec.filter.

inline fun AbstractCopyTask.filter(filterType: KClass<out FilterReader>): AbstractCopyTask
inline fun AbstractCopyTask.filter(filterType: KClass<out FilterReader>): AbstractCopyTask
inline fun AbstractCopyTask.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): AbstractCopyTask
inline fun AbstractCopyTask.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): AbstractCopyTask

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.AbstractCopyTask.filter.

findByType
Link copied to clipboard
inline fun <T : Any> ExtensionContainer.findByType(): T?

Looks for the extension of a given type.

inline fun <T : Any> ExtensionContainer.findByType(type: KClass<T>): T?
inline fun <T : Any> ExtensionContainer.findByType(type: KClass<T>): T?

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.ExtensionContainer.findByType.

findModel
Link copied to clipboard
inline fun <T : Any> BuildController.findModel(modelType: KClass<T>): T?
inline fun <T : Any> BuildController.findModel(modelType: KClass<T>): T?
inline fun <T : Any> BuildController.findModel(target: Model, modelType: KClass<T>): T?
inline fun <T : Any> BuildController.findModel(target: Model, modelType: KClass<T>): T?
inline fun <T : Any, P : Any> BuildController.findModel(modelType: KClass<T>, parameterType: KClass<P>, parameterInitializer: Action<in P>): T?
inline fun <T : Any, P : Any> BuildController.findModel(modelType: KClass<T>, parameterType: KClass<P>, parameterInitializer: Action<in P>): T?
inline fun <T : Any, P : Any> BuildController.findModel(target: Model, modelType: KClass<T>, parameterType: KClass<P>, parameterInitializer: Action<in P>): T?
inline fun <T : Any, P : Any> BuildController.findModel(target: Model, modelType: KClass<T>, parameterType: KClass<P>, parameterInitializer: Action<in P>): T?

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.tooling.BuildController.findModel.

findPlugin
Link copied to clipboard
inline fun <T : Plugin<*>> PluginContainer.findPlugin(type: KClass<T>): T?
inline fun <T : Plugin<*>> PluginContainer.findPlugin(type: KClass<T>): T?

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.findPlugin.

flatDir
Link copied to clipboard
inline fun RepositoryHandler.flatDir(vararg args: Pair<String, Any>): FlatDirectoryArtifactRepository
inline fun RepositoryHandler.flatDir(vararg args: Pair<String, Any>): FlatDirectoryArtifactRepository

Kotlin extension function for org.gradle.api.artifacts.dsl.RepositoryHandler.flatDir.

from
Link copied to clipboard
inline fun <T : VersionControlSpec> VcsMapping.from(noinline configureAction: T.() -> Unit)

Specifies the VCS location for the requested component.

inline fun <T : VersionControlSpec> VcsMapping.from(type: KClass<T>, configureAction: Action<in T>)
inline fun <T : VersionControlSpec> VcsMapping.from(type: KClass<T>, configureAction: Action<in T>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.vcs.VcsMapping.from.

get
Link copied to clipboard
operator fun <T : Any> NamedDomainObjectCollection<T>.get(name: String): T

Locates an object by name, failing if there is no such object.

operator fun ExtensionContainer.get(name: String): Any

Looks for the extension of a given name. If none found it will throw an exception.

@Incubating
inline fun <T : Any> CustomAdditionalData.get(viewType: KClass<T>): T
@Incubating
inline fun <T : Any> CustomAdditionalData.get(viewType: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.tooling.events.problems.CustomAdditionalData.get.

inline fun <S : Any, T : SoftwareComponent> BinaryCollection<T>.get(type: KClass<S>, spec: Spec<in S>): BinaryProvider<S>
inline fun <S : Any, T : SoftwareComponent> BinaryCollection<T>.get(type: KClass<S>, spec: Spec<in S>): BinaryProvider<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.language.BinaryCollection.get.

getArtifacts
Link copied to clipboard
inline fun ComponentArtifactsResult.getArtifacts(type: KClass<out Artifact>): Set<ArtifactResult>
inline fun ComponentArtifactsResult.getArtifacts(type: KClass<out Artifact>): Set<ArtifactResult>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.result.ComponentArtifactsResult.getArtifacts.

getAt
Link copied to clipboard
inline fun <T : Plugin<*>> PluginContainer.getAt(type: KClass<T>): T
inline fun <T : Plugin<*>> PluginContainer.getAt(type: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.getAt.

getByName
Link copied to clipboard
inline fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String): <Error class: unknown class>

Locates an object by name and casts it to the expected type T.

inline fun <T : Any> ExtensionContainer.getByName(name: String): <Error class: unknown class>

Looks for the extension of a given name and casts it to the expected type T.

inline fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, configure: T.() -> Unit): <Error class: unknown class>

Locates an object by name and casts it to the expected type T then configures it.

fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, type: KClass<T>): T

Locates an object by name and casts it to the expected type.

fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, type: KClass<T>, configure: T.() -> Unit): T

Locates an object by name and casts it to the expected type then configures it.

getByType
Link copied to clipboard
inline fun <T : Any> ExtensionContainer.getByType(): T

Looks for the extension of a given type.

inline fun <T : Any> ExtensionContainer.getByType(type: KClass<T>): T
inline fun <T : Any> ExtensionContainer.getByType(type: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.ExtensionContainer.getByType.

getCanQueryProjectModelInParallel
Link copied to clipboard
inline fun BuildController.getCanQueryProjectModelInParallel(modelType: KClass<*>): Boolean
inline fun BuildController.getCanQueryProjectModelInParallel(modelType: KClass<*>): Boolean

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.tooling.BuildController.getCanQueryProjectModelInParallel.

getCredentials
Link copied to clipboard
inline fun <T : Credentials> AuthenticationSupported.getCredentials(credentialsType: KClass<T>): T
inline fun <T : Credentials> AuthenticationSupported.getCredentials(credentialsType: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.repositories.AuthenticationSupported.getCredentials.

getDescriptor
Link copied to clipboard
inline fun <T : Any> ComponentMetadataContext.getDescriptor(descriptorClass: KClass<T>): T?
inline fun <T : Any> ComponentMetadataContext.getDescriptor(descriptorClass: KClass<T>): T?

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.ComponentMetadataContext.getDescriptor.

inline fun <T : Any> ComponentSelection.getDescriptor(descriptorClass: KClass<T>): T?
inline fun <T : Any> ComponentSelection.getDescriptor(descriptorClass: KClass<T>): T?

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.ComponentSelection.getDescriptor.

getModel
Link copied to clipboard
inline fun <T : Any> BuildController.getModel(modelType: KClass<T>): T
inline fun <T : Any> BuildController.getModel(modelType: KClass<T>): T
inline fun <T : Any> BuildController.getModel(target: Model, modelType: KClass<T>): T
inline fun <T : Any> BuildController.getModel(target: Model, modelType: KClass<T>): T
inline fun <T : Any, P : Any> BuildController.getModel(modelType: KClass<T>, parameterType: KClass<P>, parameterInitializer: Action<in P>): T
inline fun <T : Any, P : Any> BuildController.getModel(modelType: KClass<T>, parameterType: KClass<P>, parameterInitializer: Action<in P>): T
inline fun <T : Any, P : Any> BuildController.getModel(target: Model, modelType: KClass<T>, parameterType: KClass<P>, parameterInitializer: Action<in P>): T
inline fun <T : Any, P : Any> BuildController.getModel(target: Model, modelType: KClass<T>, parameterType: KClass<P>, parameterInitializer: Action<in P>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.tooling.BuildController.getModel.

inline fun <T : Any> ProjectConnection.getModel(modelType: KClass<T>): T
inline fun <T : Any> ProjectConnection.getModel(modelType: KClass<T>): T
inline fun <T : Any> ProjectConnection.getModel(modelType: KClass<T>, handler: ResultHandler<in T>)
inline fun <T : Any> ProjectConnection.getModel(modelType: KClass<T>, handler: ResultHandler<in T>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.tooling.ProjectConnection.getModel.

getPlugin
Link copied to clipboard
inline fun <T : Plugin<*>> PluginContainer.getPlugin(type: KClass<T>): T
inline fun <T : Plugin<*>> PluginContainer.getPlugin(type: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.getPlugin.

getting
Link copied to clipboard
fun <T : Any, U : NamedDomainObjectCollection<T>> U.getting(configuration: T.() -> Unit): NamedDomainObjectCollectionDelegateProvider<T>

Idiomatic way of referring and configuring an existing element in a collection via a delegate property.

fun <T : Any, U : T> NamedDomainObjectContainer<T>.getting(type: KClass<U>): PolymorphicDomainObjectContainerGettingDelegateProvider<T, U>

Provides a property delegate that gets elements of the given type.

fun <T : Any, U : T> NamedDomainObjectContainer<T>.getting(type: KClass<U>, configuration: U.() -> Unit): PolymorphicDomainObjectContainerGettingDelegateProvider<T, U>

Provides a property delegate that gets elements of the given type and applies the given configuration.

getValue
Link copied to clipboard
inline operator fun <T : Any, U : T> NamedDomainObjectProvider<out T>.getValue(thisRef: Any?, property: KProperty<*>): U

Allows a NamedDomainObjectProvider to be used as a property delegate.

operator fun ConfigurableFileCollection.getValue(receiver: Any?, property: KProperty<*>): ConfigurableFileCollection

Property delegate for ConfigurableFileCollection instances.

inline operator fun <T : Any> ExtensionContainer.getValue(thisRef: Any?, property: KProperty<*>): T

Delegated property getter that locates extensions.

operator fun <T : Any> Property<T>.getValue(receiver: Any?, property: KProperty<*>): T

Property delegate for Property instances.

operator fun <T> ExistingDomainObjectDelegate<out T>.getValue(receiver: Any?, property: KProperty<*>): T

Gets the delegate value.

gradleKotlinDsl
Link copied to clipboard
fun Project.gradleKotlinDsl(): Dependency

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

hasPlugin
Link copied to clipboard
inline fun PluginContainer.hasPlugin(type: KClass<out Plugin<*>>): Boolean
inline fun PluginContainer.hasPlugin(type: KClass<out Plugin<*>>): Boolean

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.hasPlugin.

internalView
Link copied to clipboard
@Incubating
inline fun <T : Any> TypeBuilder<T>.internalView(internalView: KClass<*>): TypeBuilder<T>
@Incubating
inline fun <T : Any> TypeBuilder<T>.internalView(internalView: KClass<*>): TypeBuilder<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.platform.base.TypeBuilder.internalView.

invoke
Link copied to clipboard
operator fun <T> Closure<T>.invoke(): T
operator fun <T> Closure<T>.invoke(x: Any?): T
operator fun <T> Closure<T>.invoke(vararg xs: Any?): T

Enables function invocation syntax on Closure references.

operator fun <V> Callable<V>.invoke(): V

Enables function invocation syntax on Callable references.

inline operator fun <T : Any, C : NamedDomainObjectContainer<T>> C.invoke(configuration: Action<NamedDomainObjectContainerScope<T>>): C
inline operator fun ConfigurationContainer.invoke(configuration: Action<ConfigurationContainerScope>): ConfigurationContainer

Allows the container to be configured via an augmented DSL.

operator fun <T : Any> Action<in T>.invoke(target: T)

Enables function invocation syntax on Action references.

operator fun <T : Any> NamedDomainObjectProvider<T>.invoke(action: T.() -> Unit)

Allows a NamedDomainObjectProvider to be configured via invocation syntax.

operator fun ArtifactHandler.invoke(configuration: ArtifactHandlerScope.() -> Unit)

Configures the published artifacts for this project.

operator fun DependencyCollector.invoke(dependencyNotation: CharSequence)
operator fun DependencyCollector.invoke(dependency: Dependency)
operator fun DependencyCollector.invoke(files: FileCollection)
@Incubating
operator fun DependencyCollector.invoke(externalModule: ProviderConvertible<out MinimalExternalModuleDependency>)
operator fun DependencyCollector.invoke(dependency: Provider<out Dependency>)
operator fun <D : Dependency> DependencyCollector.invoke(dependency: D, configuration: Action<in D>)
operator fun DependencyCollector.invoke(dependencyNotation: CharSequence, configuration: Action<in ExternalModuleDependency>)
operator fun DependencyCollector.invoke(files: FileCollection, configuration: Action<in FileCollectionDependency>)
@Incubating
operator fun DependencyCollector.invoke(externalModule: ProviderConvertible<out MinimalExternalModuleDependency>, configuration: Action<in ExternalModuleDependency>)
operator fun <D : Dependency> DependencyCollector.invoke(dependency: Provider<out D>, configuration: Action<in D>)

Add a dependency.

operator fun DependencyCollector.invoke(dependencyConstraint: DependencyConstraint)
@JvmName(name = "invokeConstraint")
operator fun DependencyCollector.invoke(dependencyConstraint: Provider<out DependencyConstraint>)
operator fun DependencyCollector.invoke(dependencyConstraint: DependencyConstraint, configuration: Action<in DependencyConstraint>)
@JvmName(name = "invokeConstraint")
operator fun DependencyCollector.invoke(dependencyConstraint: Provider<out DependencyConstraint>, configuration: Action<in DependencyConstraint>)

Add a dependency constraint.

operator fun DependencyConstraintHandler.invoke(configuration: DependencyConstraintHandlerScope.() -> Unit)

Configures the dependency constraints.

operator fun <D : ModuleDependency> DependencyModifier.invoke(dependency: D): D
operator fun DependencyModifier.invoke(dependencyNotation: CharSequence): ExternalModuleDependency
@Incubating
operator fun DependencyModifier.invoke(dependency: ProviderConvertible<out MinimalExternalModuleDependency>): Provider<out MinimalExternalModuleDependency>
operator fun DependencyModifier.invoke(dependency: Provider<out ModuleDependency>): Provider<out ModuleDependency>

Modifies a dependency to select the variant of the given module.

operator fun <T> ExtraPropertiesExtension.invoke(initialValue: T): InitialValueExtraPropertyDelegateProvider<T>

Returns a property delegate provider that will initialize the extra property to the given initialValue.

inline operator fun <T> ExtraPropertiesExtension.invoke(initialValueProvider: () -> T): InitialValueExtraPropertyDelegateProvider<T>

Returns a property delegate provider that will initialize the extra property to the value provided by initialValueProvider.

operator fun <T> Spec<T>.invoke(arg: T): Boolean

Enables function invocation syntax on Spec instances.

inline operator fun TaskContainer.invoke(configuration: TaskContainerScope.() -> Unit): TaskContainer

Allows a TaskContainer to be configured via an augmented DSL that includes a shorthand string notation for configuring existing tasks.

ivy
Link copied to clipboard
fun RepositoryHandler.ivy(url: Any): IvyArtifactRepository
fun RepositoryHandler.ivy(url: Any, action: IvyArtifactRepository.() -> Unit): IvyArtifactRepository

Adds and configures an Ivy repository.

jvm
Link copied to clipboard
@Incubating
fun ToolchainManagement.jvm(block: JvmToolchainManagement.() -> Unit)

Provides statically defined accessors for configuring the "jvm" block in "toolchainManagement". The "jvm-toolchain-management" plugin needs to be applied in order for these extensions to work.

kotlin
Link copied to clipboard
fun PluginDependenciesSpec.kotlin(module: String): PluginDependencySpec

Applies the given Kotlin plugin module.

fun DependencyHandler.kotlin(module: String, version: String? = null): Any

Builds the dependency notation for the named Kotlin module at the given version.

listProperty
Link copied to clipboard
inline fun <T : Any> ObjectFactory.listProperty(): ListProperty<T>

Creates a ListProperty that holds values of the given type T.

inline fun <T : Any> ObjectFactory.listProperty(elementType: KClass<T>): ListProperty<T>
inline fun <T : Any> ObjectFactory.listProperty(elementType: KClass<T>): ListProperty<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.listProperty.

mapProperty
Link copied to clipboard
inline fun <K : Any, V : Any> ObjectFactory.mapProperty(): MapProperty<K, V>

Creates a MapProperty that holds values of the given key type K and value type V.

inline fun <K : Any, V : Any> ObjectFactory.mapProperty(keyType: KClass<K>, valueType: KClass<V>): MapProperty<K, V>
inline fun <K : Any, V : Any> ObjectFactory.mapProperty(keyType: KClass<K>, valueType: KClass<V>): MapProperty<K, V>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.mapProperty.

maven
Link copied to clipboard
fun RepositoryHandler.maven(url: Any): MavenArtifactRepository
fun RepositoryHandler.maven(url: Any, action: MavenArtifactRepository.() -> Unit): MavenArtifactRepository

Adds and configures a Maven repository.

mavenCentral
Link copied to clipboard
inline fun RepositoryHandler.mavenCentral(vararg args: Pair<String, Any>): MavenArtifactRepository
inline fun RepositoryHandler.mavenCentral(vararg args: Pair<String, Any>): MavenArtifactRepository

Kotlin extension function for org.gradle.api.artifacts.dsl.RepositoryHandler.mavenCentral.

maybeCreate
Link copied to clipboard
inline fun <U : Any> PolymorphicDomainObjectContainer<in U>.maybeCreate(name: String): <Error class: unknown class>

Creates a domain object with the specified name and type if it does not exists, and adds it to the container.

inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.maybeCreate(name: String, type: KClass<U>): U
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.maybeCreate(name: String, type: KClass<U>): U

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.PolymorphicDomainObjectContainer.maybeCreate.

model
Link copied to clipboard
inline fun <T : Any> ProjectConnection.model(modelType: KClass<T>): ModelBuilder<T>
inline fun <T : Any> ProjectConnection.model(modelType: KClass<T>): ModelBuilder<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.tooling.ProjectConnection.model.

module
Link copied to clipboard
fun Dependencies.module(group: String?, name: String, version: String?): ExternalModuleDependency

Creates a dependency based on the group, name and version (GAV) coordinates.

named
Link copied to clipboard
inline fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String): NamedDomainObjectProvider<T>
fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, type: KClass<T>): NamedDomainObjectProvider<T>

Locates an object by name and type, without triggering its creation or configuration, failing if there is no such object.

inline fun <T : Named> ObjectFactory.named(name: String): T

Creates a simple immutable Named object of the given type and name.

inline fun <T : Task> TaskCollection<out Task>.named(name: String): TaskProvider<T>
fun <T : Task> TaskCollection<out Task>.named(name: String, type: KClass<T>): TaskProvider<T>

Locates a task by name and type, without triggering its creation or configuration, failing if there is no such task.

inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.named(name: String, type: KClass<S>): NamedDomainObjectProvider<S>
inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.named(name: String, type: KClass<S>): NamedDomainObjectProvider<S>
inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.named(name: String, type: KClass<S>, configurationAction: Action<in S>): NamedDomainObjectProvider<S>
inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.named(name: String, type: KClass<S>, configurationAction: Action<in S>): NamedDomainObjectProvider<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectCollection.named.

inline fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, noinline configuration: T.() -> Unit): NamedDomainObjectProvider<T>
fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, type: KClass<T>, configuration: T.() -> Unit): NamedDomainObjectProvider<T>

Configures an object by name and type, without triggering its creation or configuration, failing if there is no such object.

inline fun <T : Named> ObjectFactory.named(type: KClass<T>, name: String): T
inline fun <T : Named> ObjectFactory.named(type: KClass<T>, name: String): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.named.

inline fun <S : T, T : Task> TaskCollection<T>.named(name: String, type: KClass<S>): TaskProvider<S>
inline fun <S : T, T : Task> TaskCollection<T>.named(name: String, type: KClass<S>): TaskProvider<S>
inline fun <S : T, T : Task> TaskCollection<T>.named(name: String, type: KClass<S>, configurationAction: Action<in S>): TaskProvider<S>
inline fun <S : T, T : Task> TaskCollection<T>.named(name: String, type: KClass<S>, configurationAction: Action<in S>): TaskProvider<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.TaskCollection.named.

inline fun <T : Task> TaskCollection<out Task>.named(name: String, noinline configuration: T.() -> Unit): TaskProvider<T>
fun <T : Task> TaskCollection<out Task>.named(name: String, type: KClass<T>, configuration: T.() -> Unit): TaskProvider<T>

Configures a task by name and type, without triggering its creation or configuration, failing if there is no such task.

@Incubating
inline fun <T : Any> ModelMap<T>.named(name: String, ruleSource: KClass<out RuleSource>)
@Incubating
inline fun <T : Any> ModelMap<T>.named(name: String, ruleSource: KClass<out RuleSource>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.model.ModelMap.named.

namedDomainObjectList
Link copied to clipboard
inline fun <T : Any> ObjectFactory.namedDomainObjectList(elementType: KClass<T>): NamedDomainObjectList<T>
inline fun <T : Any> ObjectFactory.namedDomainObjectList(elementType: KClass<T>): NamedDomainObjectList<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.namedDomainObjectList.

namedDomainObjectSet
Link copied to clipboard
inline fun <T : Any> ObjectFactory.namedDomainObjectSet(elementType: KClass<T>): NamedDomainObjectSet<T>
inline fun <T : Any> ObjectFactory.namedDomainObjectSet(elementType: KClass<T>): NamedDomainObjectSet<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.namedDomainObjectSet.

newInstance
Link copied to clipboard
inline fun <T : Any> ObjectFactory.newInstance(vararg parameters: Any): T

Create a new instance of `T`, using parameters as the construction parameters.

inline fun <T : Any> ObjectFactory.newInstance(type: KClass<out T>, vararg parameters: Any): T
inline fun <T : Any> ObjectFactory.newInstance(type: KClass<out T>, vararg parameters: Any): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.newInstance.

of
Link copied to clipboard
inline fun <T : Any, P : ValueSourceParameters> ProviderFactory.of(valueSourceType: KClass<out ValueSource<T, P>>, configuration: Action<in ValueSourceSpec<P>>): Provider<T>
inline fun <T : Any, P : ValueSourceParameters> ProviderFactory.of(valueSourceType: KClass<out ValueSource<T, P>>, configuration: Action<in ValueSourceSpec<P>>): Provider<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.provider.ProviderFactory.of.

plugin
Link copied to clipboard
inline fun <T : Plugin<*>> ObjectConfigurationAction.plugin(): <Error class: unknown class>

Adds a Plugin to use to configure the target objects. This method may be called multiple times, to use multiple plugins. Scripts and plugins are applied in the order that they are added.

inline fun ObjectConfigurationAction.plugin(pluginClass: KClass<out Plugin<*>>): ObjectConfigurationAction
inline fun ObjectConfigurationAction.plugin(pluginClass: KClass<out Plugin<*>>): ObjectConfigurationAction

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.ObjectConfigurationAction.plugin.

plugins
Link copied to clipboard
fun Project.plugins(block: PluginDependenciesSpec.() -> Unit): Nothing

Nested `plugins` blocks are NOT allowed, for example:

polymorphicDomainObjectContainer
Link copied to clipboard
inline fun <T : Any> ObjectFactory.polymorphicDomainObjectContainer(elementType: KClass<T>): ExtensiblePolymorphicDomainObjectContainer<T>
inline fun <T : Any> ObjectFactory.polymorphicDomainObjectContainer(elementType: KClass<T>): ExtensiblePolymorphicDomainObjectContainer<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.polymorphicDomainObjectContainer.

project
Link copied to clipboard
inline fun DependencyHandler.project(vararg notation: Pair<String, Any>): Dependency
inline fun DependencyHandler.project(vararg notation: Pair<String, Any>): Dependency

Kotlin extension function for org.gradle.api.artifacts.dsl.DependencyHandler.project.

fun DependencyHandler.project(path: String, configuration: String? = null): ProjectDependency

Creates a dependency on a project without adding it to a configuration.

properties
Link copied to clipboard
inline fun TaskInputs.properties(vararg properties: Pair<String, Any>): TaskInputs
inline fun TaskInputs.properties(vararg properties: Pair<String, Any>): TaskInputs

Kotlin extension function for org.gradle.api.tasks.TaskInputs.properties.

inline fun WriteProperties.properties(vararg properties: Pair<String, Any>)
inline fun WriteProperties.properties(vararg properties: Pair<String, Any>)

Kotlin extension function for org.gradle.api.tasks.WriteProperties.properties.

property
Link copied to clipboard
inline fun <T : Any> ObjectFactory.property(): Property<T>

Creates a Property that holds values of the given type T.

inline fun <T : Any> ObjectFactory.property(valueType: KClass<T>): Property<T>
inline fun <T : Any> ObjectFactory.property(valueType: KClass<T>): Property<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.property.

provideDelegate
Link copied to clipboard
operator fun <T : Any> T.provideDelegate(receiver: Any?, property: KProperty<*>): T

Required due to KT-25810.

operator fun <T : Any> NamedDomainObjectCollection<T>.provideDelegate(thisRef: Any?, property: KProperty<*>): NamedDomainObjectProvider<T>

Allows a NamedDomainObjectCollection to be used as a property delegate.

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

Locates a property on Project.

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

Locates a property on Settings.

operator fun ExtraPropertiesExtension.provideDelegate(receiver: Any?, property: KProperty<*>): MutablePropertyDelegate

Provides property delegate for typed access to extra properties.

operator fun <T : Any, C : NamedDomainObjectCollection<T>> ExistingDomainObjectDelegateProviderWithAction<C, T>.provideDelegate(receiver: Any?, property: KProperty<*>): <Error class: unknown class>
operator fun <T : Any, C : NamedDomainObjectCollection<T>, U : T> ExistingDomainObjectDelegateProviderWithTypeAndAction<C, U>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<NamedDomainObjectProvider<U>>
operator fun <T : Any, C : NamedDomainObjectCollection<T>, U : T> ExistingDomainObjectDelegateProviderWithType<C, U>.provideDelegate(receiver: Any?, property: KProperty<*>): <Error class: unknown class>
operator fun <T : Any, C : NamedDomainObjectCollection<T>> ExistingDomainObjectDelegateProvider<C>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<NamedDomainObjectProvider<T>>

Provides access to the NamedDomainObjectProvider for the element of the given property name from the container via a delegated property.

operator fun ExistingDomainObjectDelegateProviderWithAction<out TaskContainer, Task>.provideDelegate(receiver: Any?, property: KProperty<*>): <Error class: unknown class>

Provides a TaskProvider delegate for the task named after the property after configuring it with the given action.

operator fun <U : Task> ExistingDomainObjectDelegateProviderWithTypeAndAction<out TaskContainer, U>.provideDelegate(receiver: Any?, property: KProperty<*>): <Error class: unknown class>

Provides a TaskProvider delegate for the task of the given type named after the property after configuring it with the given action.

operator fun <U : Task> ExistingDomainObjectDelegateProviderWithType<out TaskContainer, U>.provideDelegate(receiver: Any?, property: KProperty<*>): <Error class: unknown class>

Provides a TaskProvider delegate for the task of the given type named after the property.

operator fun ExistingDomainObjectDelegateProvider<out TaskContainer>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<TaskProvider<Task>>

Provides a TaskProvider delegate for the task named after the property.

operator fun <T : Any, C : NamedDomainObjectContainer<T>> RegisteringDomainObjectDelegateProviderWithAction<C, T>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<NamedDomainObjectProvider<T>>
operator fun <T : Any, C : PolymorphicDomainObjectContainer<T>, U : T> RegisteringDomainObjectDelegateProviderWithTypeAndAction<C, U>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<NamedDomainObjectProvider<U>>
operator fun <T : Any, C : PolymorphicDomainObjectContainer<T>, U : T> RegisteringDomainObjectDelegateProviderWithType<C, U>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<NamedDomainObjectProvider<T>>
operator fun <T : Any, C : NamedDomainObjectContainer<T>> RegisteringDomainObjectDelegateProvider<C>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<NamedDomainObjectProvider<T>>

Registers an element and provides a delegate with the resulting NamedDomainObjectProvider.

operator fun RegisteringDomainObjectDelegateProviderWithAction<out TaskContainer, Task>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<TaskProvider<Task>>

Registers a task that gets configured with the given action and provides a delegate with the resulting TaskProvider.

operator fun <U : Task> RegisteringDomainObjectDelegateProviderWithTypeAndAction<out TaskContainer, U>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<TaskProvider<U>>

Registers a task of the given type that gets configured with the given action and provides a delegate with the resulting TaskProvider.

operator fun <U : Task> RegisteringDomainObjectDelegateProviderWithType<out TaskContainer, U>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<TaskProvider<Task>>

Registers a task of the given type and provides a delegate with the resulting TaskProvider.

operator fun RegisteringDomainObjectDelegateProvider<out TaskContainer>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<TaskProvider<Task>>

Registers a task and provides a delegate with the resulting TaskProvider.

register
Link copied to clipboard
inline fun <T : Any> PolymorphicDomainObjectContainer<in T>.register(name: String): NamedDomainObjectProvider<T>

Defines a new object, which will be created when it is required.

inline fun <T : Task> TaskContainer.register(name: String): TaskProvider<T>

Defines a new task, which will be created when it is required.

@Incubating
inline fun <T : JavaToolchainResolver> JavaToolchainResolverRegistry.register(implementationType: KClass<T>)
@Incubating
inline fun <T : JavaToolchainResolver> JavaToolchainResolverRegistry.register(implementationType: KClass<T>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.jvm.toolchain.JavaToolchainResolverRegistry.register.

inline fun <T : Any> PolymorphicDomainObjectContainer<in T>.register(name: String, noinline configuration: T.() -> Unit): NamedDomainObjectProvider<T>

Defines and configure a new object, which will be created when it is required.

inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.register(name: String, type: KClass<U>): NamedDomainObjectProvider<U>
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.register(name: String, type: KClass<U>): NamedDomainObjectProvider<U>
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.register(name: String, type: KClass<U>, configurationAction: Action<in U>): NamedDomainObjectProvider<U>
inline fun <U : T, T : Any> PolymorphicDomainObjectContainer<T>.register(name: String, type: KClass<U>, configurationAction: Action<in U>): NamedDomainObjectProvider<U>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.PolymorphicDomainObjectContainer.register.

inline fun <T : Task> TaskContainer.register(name: String, vararg arguments: Any): TaskProvider<T>

Defines a new task, which will be created when it is required passing the given arguments to the javax.inject.Inject-annotated constructor.

inline fun <T : Task> TaskContainer.register(name: String, noinline configuration: T.() -> Unit): TaskProvider<T>

Defines and configure a new task, which will be created when it is required.

inline fun <T : Task> TaskContainer.register(name: String, type: KClass<T>): TaskProvider<T>
inline fun <T : Task> TaskContainer.register(name: String, type: KClass<T>): TaskProvider<T>
inline fun <T : Task> TaskContainer.register(name: String, type: KClass<T>, vararg constructorArgs: Any): TaskProvider<T>
inline fun <T : Task> TaskContainer.register(name: String, type: KClass<T>, vararg constructorArgs: Any): TaskProvider<T>
inline fun <T : Task> TaskContainer.register(name: String, type: KClass<T>, configurationAction: Action<in T>): TaskProvider<T>
inline fun <T : Task> TaskContainer.register(name: String, type: KClass<T>, configurationAction: Action<in T>): TaskProvider<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.TaskContainer.register.

registerBinding
Link copied to clipboard
inline fun <U : T, T : Any> ExtensiblePolymorphicDomainObjectContainer<T>.registerBinding(type: KClass<U>, implementationType: KClass<out U>)
inline fun <U : T, T : Any> ExtensiblePolymorphicDomainObjectContainer<T>.registerBinding(type: KClass<U>, implementationType: KClass<out U>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.ExtensiblePolymorphicDomainObjectContainer.registerBinding.

registerBuildCacheService
Link copied to clipboard
inline fun <T : BuildCache> BuildCacheConfiguration.registerBuildCacheService(buildCacheServiceFactoryType: KClass<out BuildCacheServiceFactory<in T>>)

Registers a custom build cache type.

inline fun <T : BuildCache> BuildCacheConfiguration.registerBuildCacheService(configurationType: KClass<T>, buildCacheServiceFactoryType: KClass<out BuildCacheServiceFactory<in T>>)
inline fun <T : BuildCache> BuildCacheConfiguration.registerBuildCacheService(configurationType: KClass<T>, buildCacheServiceFactoryType: KClass<out BuildCacheServiceFactory<in T>>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.caching.configuration.BuildCacheConfiguration.registerBuildCacheService.

registerIfAbsent
Link copied to clipboard
inline fun <T : BuildService<P>, P : BuildServiceParameters> BuildServiceRegistry.registerIfAbsent(name: String, implementationType: KClass<T>): Provider<T>
inline fun <T : BuildService<P>, P : BuildServiceParameters> BuildServiceRegistry.registerIfAbsent(name: String, implementationType: KClass<T>): Provider<T>
inline fun <T : BuildService<P>, P : BuildServiceParameters> BuildServiceRegistry.registerIfAbsent(name: String, implementationType: KClass<T>, configureAction: Action<in BuildServiceSpec<P>>): Provider<T>
inline fun <T : BuildService<P>, P : BuildServiceParameters> BuildServiceRegistry.registerIfAbsent(name: String, implementationType: KClass<T>, configureAction: Action<in BuildServiceSpec<P>>): Provider<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.services.BuildServiceRegistry.registerIfAbsent.

registering
Link copied to clipboard
fun <T : Any, C : NamedDomainObjectContainer<T>> C.registering(action: T.() -> Unit): RegisteringDomainObjectDelegateProviderWithAction<out C, T>
fun <T : Any, C : PolymorphicDomainObjectContainer<T>, U : T> C.registering(type: KClass<U>): RegisteringDomainObjectDelegateProviderWithType<out C, U>
fun <T : Any, C : PolymorphicDomainObjectContainer<T>, U : T> C.registering(type: KClass<U>, action: U.() -> Unit): RegisteringDomainObjectDelegateProviderWithTypeAndAction<out C, U>

Property delegate for registering new elements in the container.

registerTransform
Link copied to clipboard
inline fun <T : TransformParameters> DependencyHandler.registerTransform(actionType: KClass<out TransformAction<T>>, registrationAction: Action<in TransformSpec<T>>)
inline fun <T : TransformParameters> DependencyHandler.registerTransform(actionType: KClass<out TransformAction<T>>, registrationAction: Action<in TransformSpec<T>>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.dsl.DependencyHandler.registerTransform.

remote
Link copied to clipboard
inline fun <T : BuildCache> BuildCacheConfiguration.remote(): T
inline fun <T : BuildCache> BuildCacheConfiguration.remote(noinline configuration: T.() -> Unit): T

Configures a remote cache with the given type.

inline fun <T : BuildCache> BuildCacheConfiguration.remote(type: KClass<T>): T
inline fun <T : BuildCache> BuildCacheConfiguration.remote(type: KClass<T>): T
inline fun <T : BuildCache> BuildCacheConfiguration.remote(type: KClass<T>, configuration: Action<in T>): T
inline fun <T : BuildCache> BuildCacheConfiguration.remote(type: KClass<T>, configuration: Action<in T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.caching.configuration.BuildCacheConfiguration.remote.

replace
Link copied to clipboard
inline fun <T : Task> TaskContainer.replace(name: String, type: KClass<T>): T
inline fun <T : Task> TaskContainer.replace(name: String, type: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.TaskContainer.replace.

repositories
Link copied to clipboard
fun Project.repositories(configuration: RepositoryHandler.() -> Unit)

Configures the repositories for this project.

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

Configures the repositories for the script dependencies.

setComponentVersionsLister
Link copied to clipboard
inline fun MetadataSupplierAware.setComponentVersionsLister(lister: KClass<out ComponentMetadataVersionLister>)
inline fun MetadataSupplierAware.setComponentVersionsLister(lister: KClass<out ComponentMetadataVersionLister>)
inline fun MetadataSupplierAware.setComponentVersionsLister(lister: KClass<out ComponentMetadataVersionLister>, configureAction: Action<in ActionConfiguration>)
inline fun MetadataSupplierAware.setComponentVersionsLister(lister: KClass<out ComponentMetadataVersionLister>, configureAction: Action<in ActionConfiguration>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.repositories.MetadataSupplierAware.setComponentVersionsLister.

setConfigProperties
Link copied to clipboard
inline fun Checkstyle.setConfigProperties(vararg configProperties: Pair<String, Any>)
inline fun Checkstyle.setConfigProperties(vararg configProperties: Pair<String, Any>)

Kotlin extension function for org.gradle.api.plugins.quality.Checkstyle.setConfigProperties.

inline fun CheckstyleExtension.setConfigProperties(vararg configProperties: Pair<String, Any>)
inline fun CheckstyleExtension.setConfigProperties(vararg configProperties: Pair<String, Any>)

Kotlin extension function for org.gradle.api.plugins.quality.CheckstyleExtension.setConfigProperties.

setEnvironment
Link copied to clipboard
inline fun ProcessForkOptions.setEnvironment(vararg environmentVariables: Pair<String, Any>)
inline fun ProcessForkOptions.setEnvironment(vararg environmentVariables: Pair<String, Any>)

Kotlin extension function for org.gradle.process.ProcessForkOptions.setEnvironment.

setMetadataSupplier
Link copied to clipboard
inline fun MetadataSupplierAware.setMetadataSupplier(rule: KClass<out ComponentMetadataSupplier>)
inline fun MetadataSupplierAware.setMetadataSupplier(rule: KClass<out ComponentMetadataSupplier>)
inline fun MetadataSupplierAware.setMetadataSupplier(rule: KClass<out ComponentMetadataSupplier>, configureAction: Action<in ActionConfiguration>)
inline fun MetadataSupplierAware.setMetadataSupplier(rule: KClass<out ComponentMetadataSupplier>, configureAction: Action<in ActionConfiguration>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.repositories.MetadataSupplierAware.setMetadataSupplier.

setProperties
Link copied to clipboard
inline fun WriteProperties.setProperties(vararg properties: Pair<String, Any>)
inline fun WriteProperties.setProperties(vararg properties: Pair<String, Any>)

Kotlin extension function for org.gradle.api.tasks.WriteProperties.setProperties.

setProperty
Link copied to clipboard
inline fun <T : Any> ObjectFactory.setProperty(): SetProperty<T>

Creates a SetProperty that holds values of the given type T.

inline fun <T : Any> ObjectFactory.setProperty(elementType: KClass<T>): SetProperty<T>
inline fun <T : Any> ObjectFactory.setProperty(elementType: KClass<T>): SetProperty<T>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.model.ObjectFactory.setProperty.

setSystemProperties
Link copied to clipboard
inline fun JavaForkOptions.setSystemProperties(vararg properties: Pair<String, Any>)
inline fun JavaForkOptions.setSystemProperties(vararg properties: Pair<String, Any>)

Kotlin extension function for org.gradle.process.JavaForkOptions.setSystemProperties.

setValue
Link copied to clipboard
operator fun ConfigurableFileCollection.setValue(receiver: Any?, property: KProperty<*>, value: Iterable<*>)

Property delegate for ConfigurableFileCollection instances.

operator fun <T : Any> Property<T>.setValue(receiver: Any?, property: KProperty<*>, value: T)

Property delegate for Property instances.

submit
Link copied to clipboard
inline fun <T : WorkParameters> WorkQueue.submit(workActionClass: KClass<out WorkAction<T>>, parameterAction: Action<in T>)
inline fun <T : WorkParameters> WorkQueue.submit(workActionClass: KClass<out WorkAction<T>>, parameterAction: Action<in T>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.workers.WorkQueue.submit.

systemProperties
Link copied to clipboard
inline fun JavaExec.systemProperties(vararg properties: Pair<String, Any>): JavaExec
inline fun JavaExec.systemProperties(vararg properties: Pair<String, Any>): JavaExec

Kotlin extension function for org.gradle.api.tasks.JavaExec.systemProperties.

inline fun Test.systemProperties(vararg properties: Pair<String, Any>): Test
inline fun Test.systemProperties(vararg properties: Pair<String, Any>): Test

Kotlin extension function for org.gradle.api.tasks.testing.Test.systemProperties.

inline fun JavaForkOptions.systemProperties(vararg properties: Pair<String, Any>): JavaForkOptions
inline fun JavaForkOptions.systemProperties(vararg properties: Pair<String, Any>): JavaForkOptions

Kotlin extension function for org.gradle.process.JavaForkOptions.systemProperties.

task
Link copied to clipboard
inline fun <type : Task> Project.task(name: String): <Error class: unknown class>

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
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
Link copied to clipboard
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.

type
Link copied to clipboard
inline fun ObjectConfigurationAction.type(pluginClass: KClass<*>): ObjectConfigurationAction
inline fun ObjectConfigurationAction.type(pluginClass: KClass<*>): ObjectConfigurationAction

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.ObjectConfigurationAction.type.

typeOf
Link copied to clipboard
inline fun <T> typeOf(): TypeOf<T>

Creates an instance of TypeOf for the given parameterized type.

version
Link copied to clipboard
infix fun PluginDependencySpec.version(version: String?): PluginDependencySpec
infix fun PluginDependencySpec.version(version: Provider<String>): PluginDependencySpec

Specify the version of the plugin to depend on.

whenElementFinalized
Link copied to clipboard
inline fun <S : Any, T : SoftwareComponent> BinaryCollection<T>.whenElementFinalized(type: KClass<S>, action: Action<in S>)
inline fun <S : Any, T : SoftwareComponent> BinaryCollection<T>.whenElementFinalized(type: KClass<S>, action: Action<in S>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.language.BinaryCollection.whenElementFinalized.

whenElementKnown
Link copied to clipboard
inline fun <S : Any, T : SoftwareComponent> BinaryCollection<T>.whenElementKnown(type: KClass<S>, action: Action<in S>)
inline fun <S : Any, T : SoftwareComponent> BinaryCollection<T>.whenElementKnown(type: KClass<S>, action: Action<in S>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.language.BinaryCollection.whenElementKnown.

withArtifacts
Link copied to clipboard
inline fun ArtifactResolutionQuery.withArtifacts(componentType: KClass<out Component>, vararg artifactTypes: KClass<out Artifact>): ArtifactResolutionQuery
inline fun ArtifactResolutionQuery.withArtifacts(componentType: KClass<out Component>, vararg artifactTypes: KClass<out Artifact>): ArtifactResolutionQuery
inline fun ArtifactResolutionQuery.withArtifacts(componentType: KClass<out Component>, artifactTypes: Collection<KClass<out Artifact>>): ArtifactResolutionQuery
inline fun ArtifactResolutionQuery.withArtifacts(componentType: KClass<out Component>, artifactTypes: Collection<KClass<out Artifact>>): ArtifactResolutionQuery

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.query.ArtifactResolutionQuery.withArtifacts.

withGroovyBuilder
Link copied to clipboard
inline fun <T> Any.withGroovyBuilder(builder: GroovyBuilderScope.() -> T): T

Executes the given builder against this object's GroovyBuilderScope.

withModule
Link copied to clipboard
inline fun <T : ComponentMetadataRule> ComponentMetadataHandler.withModule(id: Any): ComponentMetadataHandler
inline fun <T : ComponentMetadataRule> ComponentMetadataHandler.withModule(id: Any, configureAction: Action<in ActionConfiguration>): ComponentMetadataHandler

Adds a class based rule that may modify the metadata of any resolved software component belonging to the specified module.

inline fun ComponentMetadataHandler.withModule(id: Any, rule: KClass<out ComponentMetadataRule>): ComponentMetadataHandler
inline fun ComponentMetadataHandler.withModule(id: Any, rule: KClass<out ComponentMetadataRule>): ComponentMetadataHandler
inline fun ComponentMetadataHandler.withModule(id: Any, rule: KClass<out ComponentMetadataRule>, configureAction: Action<in ActionConfiguration>): ComponentMetadataHandler
inline fun ComponentMetadataHandler.withModule(id: Any, rule: KClass<out ComponentMetadataRule>, configureAction: Action<in ActionConfiguration>): ComponentMetadataHandler

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.artifacts.dsl.ComponentMetadataHandler.withModule.

withNormalizer
Link copied to clipboard
inline fun TaskInputFilePropertyBuilder.withNormalizer(normalizer: KClass<out FileNormalizer>): TaskInputFilePropertyBuilder
inline fun TaskInputFilePropertyBuilder.withNormalizer(normalizer: KClass<out FileNormalizer>): TaskInputFilePropertyBuilder

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.TaskInputFilePropertyBuilder.withNormalizer.

withType
Link copied to clipboard
inline fun <S : Any> DomainObjectCollection<in S>.withType(): <Error class: unknown class>
inline fun <S : Any> NamedDomainObjectCollection<in S>.withType(): NamedDomainObjectCollection<S>
inline fun <S : Task> TaskCollection<in S>.withType(): TaskCollection<S>

Returns a collection containing the objects in this collection of the given type. The returned collection is live, so that when matching objects are later added to this collection, they are also visible in the filtered collection.

inline fun <S : Any> DomainObjectCollection<in S>.withType(noinline configuration: S.() -> Unit): DomainObjectCollection<S>

Returns a collection containing the objects in this collection of the given type. Equivalent to calling `withType(type).all(configureAction)`.

inline fun <S : T, T : Any> DomainObjectCollection<T>.withType(type: KClass<S>): DomainObjectCollection<S>
inline fun <S : T, T : Any> DomainObjectCollection<T>.withType(type: KClass<S>): DomainObjectCollection<S>
inline fun <S : T, T : Any> DomainObjectCollection<T>.withType(type: KClass<S>, configureAction: Action<in S>): DomainObjectCollection<S>
inline fun <S : T, T : Any> DomainObjectCollection<T>.withType(type: KClass<S>, configureAction: Action<in S>): DomainObjectCollection<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.DomainObjectCollection.withType.

inline fun <S : T, T : Any> DomainObjectSet<T>.withType(type: KClass<S>): DomainObjectSet<S>
inline fun <S : T, T : Any> DomainObjectSet<T>.withType(type: KClass<S>): DomainObjectSet<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.DomainObjectSet.withType.

inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.withType(type: KClass<S>): NamedDomainObjectCollection<S>
inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.withType(type: KClass<S>): NamedDomainObjectCollection<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectCollection.withType.

inline fun <S : T, T : Any> NamedDomainObjectList<T>.withType(type: KClass<S>): NamedDomainObjectList<S>
inline fun <S : T, T : Any> NamedDomainObjectList<T>.withType(type: KClass<S>): NamedDomainObjectList<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectList.withType.

inline fun <S : T, T : Any> NamedDomainObjectSet<T>.withType(type: KClass<S>): NamedDomainObjectSet<S>
inline fun <S : T, T : Any> NamedDomainObjectSet<T>.withType(type: KClass<S>): NamedDomainObjectSet<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectSet.withType.

inline fun <S : T, T : Plugin<*>> PluginCollection<T>.withType(type: KClass<S>): PluginCollection<S>
inline fun <S : T, T : Plugin<*>> PluginCollection<T>.withType(type: KClass<S>): PluginCollection<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginCollection.withType.

inline fun <S : T, T : Task> TaskCollection<T>.withType(type: KClass<S>): TaskCollection<S>
inline fun <S : T, T : Task> TaskCollection<T>.withType(type: KClass<S>): TaskCollection<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.TaskCollection.withType.

@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.withType(type: KClass<S>): ModelMap<S>
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.withType(type: KClass<S>): ModelMap<S>
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.withType(type: KClass<S>, rules: KClass<out RuleSource>)
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.withType(type: KClass<S>, rules: KClass<out RuleSource>)
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.withType(type: KClass<S>, configAction: Action<in S>)
@Incubating
inline fun <S : Any, T : Any> ModelMap<T>.withType(type: KClass<S>, configAction: Action<in S>)

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.model.ModelMap.withType.