gradle/org.gradle.kotlin.dsl

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

class ArtifactHandlerScope : ArtifactHandlerDelegate

Receiver for artifacts block providing convenient utilities for configuring artifacts.

ClientModuleScope

class ~~ClientModuleScope~~(dependencyHandler: DependencyHandler, val clientModule: ClientModule) : ClientModuleDelegate

Receiver for ClientModule configuration blocks.

ConfigurationContainerScope

class ConfigurationContainerScope : NamedDomainObjectContainerScope<Configuration> , ConfigurationContainer

Receiver for ConfigurationContainer configuration blocks.

DependencyConstraintHandlerScope

class DependencyConstraintHandlerScope : DependencyConstraintHandlerDelegate

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

DependencyHandlerScope

open class DependencyHandlerScope : DependencyHandlerDelegate

Receiver for dependencies block providing convenient utilities for configuring dependencies.

ExistingDomainObjectDelegate

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

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

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

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

class ExistingDomainObjectDelegateProviderWithTypeAndAction<T, U : Any>

GradleDsl

@DslMarker

annotation class GradleDsl

Delimits a Gradle DSL.

GroovyBuilderScope

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

class InitialValueExtraPropertyDelegate<T>

Enables typed access to extra properties with initial value.

InitialValueExtraPropertyDelegateProvider

class InitialValueExtraPropertyDelegateProvider<T>

Enables typed access to extra properties with initial value.

InitScriptApi

abstract class ~~InitScriptApi~~(val delegate: Gradle) : GradleDelegate

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

KotlinBuildScript

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

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

KotlinClosure0

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

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

Adapts an unary Kotlin function to an unary Groovy Closure.

KotlinClosure2

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

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.

KotlinGradleScriptTemplate

@Incubating

abstract class KotlinGradleScriptTemplate(host: KotlinScriptHost<Gradle>) : DefaultKotlinScript, PluginAware

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

KotlinInitScript

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

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

KotlinProjectScriptTemplate

@Incubating

abstract class KotlinProjectScriptTemplate(host: KotlinScriptHost<Project>) : DefaultKotlinScript

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

KotlinScript

interface KotlinScript

Base contract for all Gradle Kotlin DSL scripts.

KotlinSettingsScript

abstract class ~~KotlinSettingsScript~~(host: KotlinScriptHost<Settings>) : SettingsScriptApi

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

KotlinSettingsScriptTemplate

@Incubating

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

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

MutablePropertyDelegate

interface MutablePropertyDelegate : PropertyDelegate

Provides efficient access to a mutable dynamic property.

NamedDomainObjectCollectionDelegateProvider

class NamedDomainObjectCollectionDelegateProvider<T : Any>

Enables typed access to container elements via delegated properties.

NamedDomainObjectContainerCreatingDelegateProvider

class NamedDomainObjectContainerCreatingDelegateProvider<T : Any>

A property delegate that creates elements in the given NamedDomainObjectContainer.

NamedDomainObjectContainerScope

open class NamedDomainObjectContainerScope<T : Any> : NamedDomainObjectContainerDelegate<T> , PolymorphicDomainObjectContainer<T>

Receiver for NamedDomainObjectContainer configuration blocks.

PluginDependenciesSpecScope

open class PluginDependenciesSpecScope : PluginDependenciesSpec

Receiver for the plugins block.

PolymorphicDomainObjectContainerCreatingDelegateProvider

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

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

interface PropertyDelegate

Provides efficient access to a property.

RegisteringDomainObjectDelegateProvider

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

class RegisteringDomainObjectDelegateProviderWithAction<C, T>

RegisteringDomainObjectDelegateProviderWithType

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

class RegisteringDomainObjectDelegateProviderWithTypeAndAction<T, U : Any>

ScriptHandlerScope

open class ScriptHandlerScope(delegate: ScriptHandler) : ScriptHandler

Receiver for the buildscript block.

SettingsScriptApi

abstract class ~~SettingsScriptApi~~(val delegate: Settings) : SettingsDelegate

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

TaskContainerScope

class TaskContainerScope : TaskContainerDelegate

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

Properties

antlr

val PluginDependenciesSpec.antlr: PluginDependencySpec

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

application

val PluginDependenciesSpec.application: PluginDependencySpec

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

assembler

val PluginDependenciesSpec.assembler: PluginDependencySpec

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

assembler-lang

val PluginDependenciesSpec.assembler-lang: PluginDependencySpec

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

base

val PluginDependenciesSpec.base: PluginDependencySpec

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

binary-base

val PluginDependenciesSpec.binary-base: PluginDependencySpec

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

build-dashboard

val PluginDependenciesSpec.build-dashboard: PluginDependencySpec

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

build-init

val PluginDependenciesSpec.build-init: PluginDependencySpec

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

val PluginDependenciesSpec.c: PluginDependencySpec

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

c-lang

val PluginDependenciesSpec.c-lang: PluginDependencySpec

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

checkstyle

val PluginDependenciesSpec.checkstyle: PluginDependencySpec

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

clang-compiler

val PluginDependenciesSpec.clang-compiler: PluginDependencySpec

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

codenarc

val PluginDependenciesSpec.codenarc: PluginDependencySpec

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

component-base

val PluginDependenciesSpec.component-base: PluginDependencySpec

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

component-model-base

val PluginDependenciesSpec.component-model-base: PluginDependencySpec

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

cpp

val PluginDependenciesSpec.cpp: PluginDependencySpec

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

cpp-application

val PluginDependenciesSpec.cpp-application: PluginDependencySpec

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

cpp-lang

val PluginDependenciesSpec.cpp-lang: PluginDependencySpec

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

cpp-library

val PluginDependenciesSpec.cpp-library: PluginDependencySpec

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

cpp-unit-test

val PluginDependenciesSpec.cpp-unit-test: PluginDependencySpec

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

creating

val <T : Any> NamedDomainObjectContainer<T>.creating: NamedDomainObjectContainerCreatingDelegateProvider<T>

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

cunit

val PluginDependenciesSpec.cunit: PluginDependencySpec

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

cunit-test-suite

val PluginDependenciesSpec.cunit-test-suite: PluginDependencySpec

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

distribution

val PluginDependenciesSpec.distribution: PluginDependencySpec

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

ear

val PluginDependenciesSpec.ear: PluginDependencySpec

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

eclipse

val PluginDependenciesSpec.eclipse: PluginDependencySpec

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

eclipse-wtp

val PluginDependenciesSpec.eclipse-wtp: PluginDependencySpec

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

embedded-kotlin

val PluginDependenciesSpec.embedded-kotlin: PluginDependencySpec

The embedded-kotlin plugin.

embeddedKotlinVersion

val embeddedKotlinVersion: String

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

existing

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

val ExtensionAware.extra: ExtraPropertiesExtension

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

gcc-compiler

val PluginDependenciesSpec.gcc-compiler: PluginDependencySpec

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

getting

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

val PluginDependenciesSpec.google-test: PluginDependencySpec

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

google-test-test-suite

val PluginDependenciesSpec.google-test-test-suite: PluginDependencySpec

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

gradle-enterprise

val PluginDependenciesSpec.gradle-enterprise: PluginDependencySpec

The gradle-enterprise plugin.

groovy

val PluginDependenciesSpec.groovy: PluginDependencySpec

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

groovy-base

val PluginDependenciesSpec.groovy-base: PluginDependencySpec

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

groovy-gradle-plugin

val PluginDependenciesSpec.groovy-gradle-plugin: PluginDependencySpec

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

help-tasks

val PluginDependenciesSpec.help-tasks: PluginDependencySpec

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

idea

val PluginDependenciesSpec.idea: PluginDependencySpec

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

ivy-publish

val PluginDependenciesSpec.ivy-publish: PluginDependencySpec

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

jacoco

val PluginDependenciesSpec.jacoco: PluginDependencySpec

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

jacoco-report-aggregation

val PluginDependenciesSpec.jacoco-report-aggregation: PluginDependencySpec

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

java

val PluginDependenciesSpec.java: PluginDependencySpec

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

java-base

val PluginDependenciesSpec.java-base: PluginDependencySpec

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

java-gradle-plugin

val PluginDependenciesSpec.java-gradle-plugin: PluginDependencySpec

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

java-library

val PluginDependenciesSpec.java-library: PluginDependencySpec

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

java-library-distribution

val PluginDependenciesSpec.java-library-distribution: PluginDependencySpec

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

java-platform

val PluginDependenciesSpec.java-platform: PluginDependencySpec

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

java-test-fixtures

val PluginDependenciesSpec.java-test-fixtures: PluginDependencySpec

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

jvm

@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

val PluginDependenciesSpec.jvm-ecosystem: PluginDependencySpec

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

jvm-test-suite

val PluginDependenciesSpec.jvm-test-suite: PluginDependencySpec

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

jvm-toolchain-management

val PluginDependenciesSpec.jvm-toolchain-management: PluginDependencySpec

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

jvm-toolchains

val PluginDependenciesSpec.jvm-toolchains: PluginDependencySpec

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

kotlin-dsl

val PluginDependenciesSpec.kotlin-dsl: PluginDependencySpec

The kotlin-dsl plugin.

kotlin-dsl-base

val PluginDependenciesSpec.kotlin-dsl-base: PluginDependencySpec

The kotlin-dsl.base plugin.

kotlin-dsl-precompiled-script-plugins

val PluginDependenciesSpec.kotlin-dsl-precompiled-script-plugins: PluginDependencySpec

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

language-base

val PluginDependenciesSpec.language-base: PluginDependencySpec

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

lifecycle-base

val PluginDependenciesSpec.lifecycle-base: PluginDependencySpec

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

maven-publish

val PluginDependenciesSpec.maven-publish: PluginDependencySpec

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

microsoft-visual-cpp-compiler

val PluginDependenciesSpec.microsoft-visual-cpp-compiler: PluginDependencySpec

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

native-component

val PluginDependenciesSpec.native-component: PluginDependencySpec

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

native-component-model

val PluginDependenciesSpec.native-component-model: PluginDependencySpec

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

objective-c

val PluginDependenciesSpec.objective-c: PluginDependencySpec

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

objective-c-lang

val PluginDependenciesSpec.objective-c-lang: PluginDependencySpec

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

objective-cpp

val PluginDependenciesSpec.objective-cpp: PluginDependencySpec

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

objective-cpp-lang

val PluginDependenciesSpec.objective-cpp-lang: PluginDependencySpec

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

pmd

val PluginDependenciesSpec.pmd: PluginDependencySpec

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

project-report

val PluginDependenciesSpec.project-report: PluginDependencySpec

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

project-reports

val PluginDependenciesSpec.project-reports: PluginDependencySpec

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

publishing

val PluginDependenciesSpec.publishing: PluginDependencySpec

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

registering

val <T : Any, C : NamedDomainObjectContainer<T>> C.registering: RegisteringDomainObjectDelegateProvider<out C>

Property delegate for registering new elements in the container.

reporting-base

val PluginDependenciesSpec.reporting-base: PluginDependencySpec

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

scala

val PluginDependenciesSpec.scala: PluginDependencySpec

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

scala-base

val PluginDependenciesSpec.scala-base: PluginDependencySpec

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

signing

val PluginDependenciesSpec.signing: PluginDependencySpec

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

standard-tool-chains

val PluginDependenciesSpec.standard-tool-chains: PluginDependencySpec

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

swift-application

val PluginDependenciesSpec.swift-application: PluginDependencySpec

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

swift-library

val PluginDependenciesSpec.swift-library: PluginDependencySpec

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

swiftpm-export

val PluginDependenciesSpec.swiftpm-export: PluginDependencySpec

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

test-report-aggregation

val PluginDependenciesSpec.test-report-aggregation: PluginDependencySpec

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

test-suite-base

val PluginDependenciesSpec.test-suite-base: PluginDependencySpec

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

version-catalog

val PluginDependenciesSpec.version-catalog: PluginDependencySpec

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

visual-studio

val PluginDependenciesSpec.visual-studio: PluginDependencySpec

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

war

val PluginDependenciesSpec.war: PluginDependencySpec

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

windows-resource-script

val PluginDependenciesSpec.windows-resource-script: PluginDependencySpec

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

windows-resources

val PluginDependenciesSpec.windows-resources: PluginDependencySpec

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

wrapper

val PluginDependenciesSpec.wrapper: PluginDependencySpec

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

xcode

val PluginDependenciesSpec.xcode: PluginDependencySpec

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

xctest

val PluginDependenciesSpec.xctest: PluginDependencySpec

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

Functions

add

inline fun <T : Any> CompatibilityRuleChain<T>.add(rule: KClass<out AttributeCompatibilityRule<T>>)

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(rule: KClass<out AttributeDisambiguationRule<T>>)

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.

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.

afterEach

@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

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>, 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

@Incubating

inline fun FlowScope.always(action: KClass<out FlowAction>, configure: Action<in FlowActionSpec>): FlowScope.Registration

@Incubating

inline fun FlowScope.always(action: KClass<out FlowAction>, configure: Action<in FlowActionSpec>): FlowScope.Registration

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

apply

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?>)

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

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

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

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

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

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

Configures the artifacts for this project.

assign

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> 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> HasMultipleValues<T>.assign(provider: Provider<out Iterable<T?>?>)

fun <K, V> 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, V> 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> Property<T>.assign(value: T?)

Assign value: T to a property with assign operator

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

Assign value: Provider to a property with assign operator

attributes

inline fun Manifest.attributes(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

@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

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

Configures the build script classpath for this project.

closureOf

fun <T> Any.closureOf(action: T.() -> Unit): Closure<Any?>

Adapts a Kotlin function to a single argument Groovy Closure.

configure

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

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

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

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

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>)

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

configureEach

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

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

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

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

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

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

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

containerWithType

inline fun PolymorphicDomainObjectContainer<T>.containerWithType(type: KClass): NamedDomainObjectContainer

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

create

inline fun PolymorphicDomainObjectContainer<in U>.create(name: String): U

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

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

inline fun 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 PolymorphicDomainObjectContainer<T>.create(name: String, type: KClass): U

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

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

@Incubating

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, 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>, 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(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

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

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): PolymorphicDomainObjectContainerCreatingDelegateProvider<T, U>

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

fun <T : Any, U : T> PolymorphicDomainObjectContainer<T>.creating(type: Class, 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, configuration: U.() -> Unit): PolymorphicDomainObjectContainerCreatingDelegateProvider<T, U>

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

credentials

inline fun AuthenticationSupported.credentials(credentialsType: KClass<out Credentials>)

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: Provider<String>): Provider<T>

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

debug

inline fun CompileOptions.debug(vararg debugArgs: Pair<String, Any?>): CompileOptions

Kotlin extension function for org.gradle.api.tasks.compile.CompileOptions.debug.

defaultImplementation

@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

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.

define

inline fun AbstractOptions.define(vararg args: Pair<String, Any?>)

Kotlin extension function for org.gradle.api.tasks.compile.AbstractOptions.define.

delegateClosureOf

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

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

Configures the dependencies for this project.

dependencyLocking

fun ScriptHandler.dependencyLocking(configuration: DependencyLockingHandler.() -> Unit)

Configures the dependency locking for the script dependency configurations.

dir

inline fun SourceSetOutput.dir(dir: Any, vararg options: Pair<String, Any?>)

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

domainObjectContainer

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>

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

domainObjectSet

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

fun DependencyHandler.embeddedKotlin(module: String): Any

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

@Incubating

fun PluginDependenciesSpec.embeddedKotlin(module: String): PluginDependencySpec

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

environment

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

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

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

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

exclude

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

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): ExistingDomainObjectDelegateProviderWithType<out C, U>

fun <T : Any, C : NamedDomainObjectCollection<T>, U : T> C.existing(type: KClass, 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

inline fun ContentFilterable.expand(vararg properties: Pair<String, Any?>): 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?>, 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?>, action: Action<in ExpandDetails>): AbstractCopyTask

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

facet

inline fun EclipseWtpFacet.facet(vararg args: Pair<String, Any?>)

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

fileTree

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

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

filter

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>, 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>, 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>, vararg properties: Pair<String, Any?>): AbstractCopyTask

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

findByType

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?

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

findModel

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, P : Any> BuildController.findModel(modelType: KClass<T>, parameterType: KClass, parameterInitializer: Action<in P>): T?

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

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

findPlugin

inline fun <T : Any> Convention.~~findPlugin~~(): T?

fun <T : Any> Convention.~~findPlugin~~(conventionType: KClass<T>): T?

Locates the plugin convention object with the given type.

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

inline fun RepositoryHandler.flatDir(vararg args: Pair<String, Any?>): FlatDirectoryArtifactRepository

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

fork

inline fun CompileOptions.fork(vararg forkArgs: Pair<String, Any?>): CompileOptions

Kotlin extension function for org.gradle.api.tasks.compile.CompileOptions.fork.

inline fun GroovyCompileOptions.fork(vararg forkArgs: Pair<String, Any?>): GroovyCompileOptions

Kotlin extension function for org.gradle.api.tasks.compile.GroovyCompileOptions.fork.

from

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>)

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

get

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.

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

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

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

inline fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String): T

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

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

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): T

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

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

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

getCanQueryProjectModelInParallel

inline fun BuildController.getCanQueryProjectModelInParallel(modelType: KClass<*>): Boolean

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

getCredentials

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

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?

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

getModel

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, P : Any> BuildController.getModel(modelType: KClass<T>, parameterType: KClass, parameterInitializer: Action<in P>): T

inline fun <T : Any, P : Any> BuildController.getModel(target: Model, modelType: KClass<T>, parameterType: KClass, 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>, handler: ResultHandler<in T>)

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

getPlugin

inline fun <T : Any> Convention.~~getPlugin~~(): T

fun <T : Any> Convention.~~getPlugin~~(conventionType: KClass<T>): T

Locates the plugin convention object with the given type.

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

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

getPluginByName

inline fun <T : Any> Convention.~~getPluginByName~~(name: String): T

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

getting

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): PolymorphicDomainObjectContainerGettingDelegateProvider<T, U>

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

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

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

getValue

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> 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

fun Project.gradleKotlinDsl(): Dependency

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

hasPlugin

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

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

internalView

@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

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

@Incubating

inline operator fun ConfigurationContainer.invoke(configuration: Action<ConfigurationContainerScope>): ConfigurationContainer

Allows the container to be configured via an augmented DSL.

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

Enables function invocation syntax on Action references.

operator fun <T> 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)

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>)

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

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

fun RepositoryHandler.ivy(url: Any): IvyArtifactRepository

fun RepositoryHandler.ivy(url: Any, action: IvyArtifactRepository.() -> Unit): IvyArtifactRepository

Adds and configures an Ivy repository.

jvm

@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

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

inline fun <T> 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>

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

mapProperty

inline fun <K, V> 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>

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

maven

fun RepositoryHandler.maven(url: Any): MavenArtifactRepository

fun RepositoryHandler.maven(url: Any, action: MavenArtifactRepository.() -> Unit): MavenArtifactRepository

Adds and configures a Maven repository.

mavenCentral

inline fun RepositoryHandler.mavenCentral(vararg args: Pair<String, Any?>): MavenArtifactRepository

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

maybeCreate

inline fun PolymorphicDomainObjectContainer<in U>.maybeCreate(name: String): U

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

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

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

model

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

fun DependencyHandler.~~module~~(notation: Any, clientModuleConfiguration: ClientModuleScope.() -> Unit): ClientModule

fun DependencyHandler.~~module~~(group: String, name: String, version: String? = null, configuration: String? = null, classifier: String? = null, ext: String? = null): ClientModule

fun DependencyHandler.~~module~~(group: String, name: String, version: String? = null, configuration: String? = null, classifier: String? = null, ext: String? = null, clientModuleConfiguration: ClientModuleScope.() -> Unit): ClientModule

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

fun Dependencies.module(group: String?, name: String, version: String?): ExternalModuleDependency

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

named

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>, 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

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>, 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

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

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

inline fun <T> 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

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

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

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

plugin

inline fun <T : Plugin<*>> ObjectConfigurationAction.plugin(): ObjectConfigurationAction

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

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

plugins

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

Nested plugins blocks are NOT allowed, for example:

polymorphicDomainObjectContainer

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

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

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?>)

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

property

inline fun <T> 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>

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

provideDelegate

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<*>): ExistingDomainObjectDelegate<NamedDomainObjectProvider<T>>

operator fun <T : Any, C : NamedDomainObjectCollection<T>, U : T> ExistingDomainObjectDelegateProviderWithTypeAndAction<C, U>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<NamedDomainObjectProvider>

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<*>): ExistingDomainObjectDelegate<TaskProvider<Task>>

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

operator fun 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 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>

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

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 RegisteringDomainObjectDelegateProviderWithTypeAndAction<out TaskContainer, U>.provideDelegate(receiver: Any?, property: KProperty<*>): ExistingDomainObjectDelegate<TaskProvider>

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

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

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.

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 PolymorphicDomainObjectContainer<T>.register(name: String, type: KClass): NamedDomainObjectProvider

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

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>, vararg constructorArgs: Any): 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

inline fun ExtensiblePolymorphicDomainObjectContainer<T>.registerBinding(type: KClass, implementationType: KClass<out U>)

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

registerBuildCacheService

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>>)

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

registerIfAbsent

inline fun <T : BuildService, P : BuildServiceParameters> BuildServiceRegistry.registerIfAbsent(name: String, implementationType: KClass<T>): Provider<T>

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

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

registering

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): RegisteringDomainObjectDelegateProviderWithType<out C, U>

fun <T : Any, C : PolymorphicDomainObjectContainer<T>, U : T> C.registering(type: KClass, action: U.() -> Unit): RegisteringDomainObjectDelegateProviderWithTypeAndAction<out C, U>

Property delegate for registering new elements in the container.

registerTransform

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

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>, configuration: Action<in T>): T

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

replace

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

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

inline fun MetadataSupplierAware.setComponentVersionsLister(lister: KClass<out ComponentMetadataVersionLister>)

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

inline fun Checkstyle.setConfigProperties(vararg p0: Pair<String, Any?>)

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

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

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

setEnvironment

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

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

setMetadataSupplier

inline fun MetadataSupplierAware.setMetadataSupplier(rule: KClass<out ComponentMetadataSupplier>)

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

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

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

setProperty

inline fun <T> 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>

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

setValue

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

Property delegate for ConfigurableFileCollection instances.

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

Property delegate for Property instances.

submit

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

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

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

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

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

task

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

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

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

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

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

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

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

the

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

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

Returns the project extension of the specified type.

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

Returns the extension of the specified type.

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

Returns the extension of the specified extensionType.

type

inline fun ObjectConfigurationAction.type(pluginClass: KClass<*>): ObjectConfigurationAction

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

typeOf

inline fun <T> typeOf(): TypeOf<T>

Creates an instance of TypeOf for the given parameterized type.

version

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

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

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

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

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

withConvention

inline fun <ConventionType : Any, ReturnType> Any.~~withConvention~~(conventionType: KClass<ConventionType>, function: ConventionType.() -> ReturnType): ReturnType

Evaluates the given function against the convention plugin of the given conventionType.

withGroovyBuilder

inline fun <T> Any.withGroovyBuilder(builder: GroovyBuilderScope.() -> T): T

Executes the given builder against this object's GroovyBuilderScope.

withModule

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>, configureAction: Action<in ActionConfiguration>): ComponentMetadataHandler

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

withNormalizer

inline fun TaskInputFilePropertyBuilder.withNormalizer(normalizer: KClass<out FileNormalizer>): TaskInputFilePropertyBuilder

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

withType

inline fun <S : Any> DomainObjectCollection<in S>.withType(): DomainObjectCollection<S>

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>, 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>

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>

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>

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>

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>

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>

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.