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

Link copied to clipboard
class ArtifactHandlerScope : ArtifactHandlerDelegate

Receiver for artifacts block providing convenient utilities for configuring artifacts.

Link copied to clipboard
class ClientModuleScope(dependencyHandler: DependencyHandler, val clientModule: ClientModule) : ClientModuleDelegate

Receiver for ClientModule configuration blocks.

Link copied to clipboard
class DependencyConstraintHandlerScope : DependencyConstraintHandlerDelegate

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

Link copied to clipboard
open class DependencyHandlerScope : DependencyHandlerDelegate

Receiver for dependencies block providing convenient utilities for configuring dependencies.

Link copied to clipboard

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

Link copied to clipboard

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.

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.

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.

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.

Link copied to clipboard
annotation class GradleDsl

Delimits a Gradle DSL.

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.

Link copied to clipboard

Enables typed access to extra properties with initial value.

Enables typed access to extra properties with initial value.

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.

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.

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.

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

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.

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.

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

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

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.

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

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

Link copied to clipboard
interface KotlinScript

Base contract for all Gradle Kotlin DSL scripts.

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

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

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

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

Link copied to clipboard

Provides efficient access to a mutable dynamic property.

Enables typed access to container elements via delegated properties.

A property delegate that creates elements in the given NamedDomainObjectContainer.

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

Receiver for NamedDomainObjectContainer configuration blocks.

Link copied to clipboard

Receiver for the plugins block.

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

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

Link copied to clipboard

Provides efficient access to a property.

Link copied to clipboard

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.

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.

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.

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.

Link copied to clipboard

Receiver for the buildscript block.

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.

Link copied to clipboard
class TaskContainerScope : TaskContainerDelegate

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

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Property delegate for registering new elements in the container.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun <T : Any> CompatibilityRuleChain<T>.add(rule: 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(rule: 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.

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.

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.

Link copied to clipboard

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

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.

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.

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.

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.

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.

Link copied to clipboard
fun Project.artifacts(configuration: ArtifactHandlerScope.() -> Unit)

Configures the artifacts for this project.

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

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.

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.

Link copied to clipboard

Configures the build script classpath for this project.

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

Adapts a Kotlin function to a single argument Groovy Closure.

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.

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.

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

Link copied to clipboard

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

Link copied to clipboard

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.

@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>): 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.

Link copied to clipboard

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

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

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

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

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.

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

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

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.

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.

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

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

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.

Link copied to clipboard

Configures the dependencies for this project.

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

Configures the dependency locking for the script dependency configurations.

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.

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

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.

Link copied to clipboard

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

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

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.

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.

Link copied to clipboard

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

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.

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.

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.

Link copied to clipboard
inline fun <T : FilterReader> ContentFilterable.filter(vararg properties: Pair<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>, 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>, 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.

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.

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.

Link copied to clipboard
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?
inline fun <T : Plugin<*>> PluginContainer.findPlugin(type: KClass<T>): T?

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

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.

Link copied to clipboard
inline fun CompileOptions.fork(vararg forkArgs: Pair<String, Any?>): CompileOptions
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
inline fun GroovyCompileOptions.fork(vararg forkArgs: Pair<String, Any?>): GroovyCompileOptions

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

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.

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.

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.

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.

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.

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

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.

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.

Link copied to clipboard

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

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.

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.

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.

Link copied to clipboard
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
inline fun <T : Plugin<*>> PluginContainer.getPlugin(type: KClass<T>): T

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

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

Link copied to clipboard

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

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

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

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.

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.

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

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

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.

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.

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

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.

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.

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.

Link copied to clipboard

Adds and configures an Ivy repository.

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Adds and configures a Maven repository.

Link copied to clipboard

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

Link copied to clipboard

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.

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.

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

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

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.

Link copied to clipboard

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.

Link copied to clipboard

Nested plugins blocks are NOT allowed, for example:

Link copied to clipboard

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

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.

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.

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

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

Required due to KT-25810.

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.

Provides property delegate for typed access to extra properties.

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

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

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.

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

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

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

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

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

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

Link copied to clipboard

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