gradle

Kotlin DSL Reference for Gradle

Gradle’s Kotlin DSL provides an enhanced editing experience in supported IDEs, with superior content assist, refactoring, documentation, and more. For an introduction see the Kotlin DSL Primer.

The Kotlin DSL is implemented on top of Gradle’s Java API. Many of the objects, functions and properties you use in your build scripts come from the Gradle API and the APIs of the applied plugins. This reference covers both the Kotlin DSL and the Java API, but it doesn't include functionality provided by external plugins.

The main package of the Kotlin DSL is org.gradle.kotlin.dsl. All members of this package are implicitly imported and readily available in .gradle.kts scripts in addition to the Java API default imports.

Kotlin DSL Reference for Gradle

Gradle’s Kotlin DSL provides an enhanced editing experience in supported IDEs, with superior content assist, refactoring, documentation, and more. For an introduction see the Kotlin DSL Primer.

The Kotlin DSL is implemented on top of Gradle’s Java API. Many of the objects, functions and properties you use in your build scripts come from the Gradle API and the APIs of the applied plugins. This reference covers both the Kotlin DSL and the Java API, but it doesn't include functionality provided by external plugins.

The main package of the Kotlin DSL is org.gradle.kotlin.dsl. All members of this package are implicitly imported and readily available in .gradle.kts scripts in addition to the Java API default imports.

Packages

Link copied to clipboard

Classes for embedding Gradle.

Link copied to clipboard

Gradle's build language API, which is available from your build files. Location of the main interfaces involved in build scripts.

Link copied to clipboard

Classes for declaring and using artifacts and artifact dependencies.

Link copied to clipboard

Classes that provide meta-data about software components.

Link copied to clipboard

Classes used in the artifact DSL.

Link copied to clipboard

Classes for declaring and using Ivy modules.

Link copied to clipboard

Classes for declaring and using Maven modules.

Link copied to clipboard

Classes used for querying the artifacts.

Link copied to clipboard

Classes for declaring and using artifact repositories.

Link copied to clipboard

Classes that compose the resolution result

Link copied to clipboard

Provides classes, interfaces and annotations for registering and implementing artifact transforms.

Link copied to clipboard

Types related to artifact type definitions.

Link copied to clipboard

Dependency verification related configuration classes

Link copied to clipboard

Classes for dealing with configuration and artifact attributes.

Link copied to clipboard

Attributes specific to the Java ecosystem.

Link copied to clipboard

Attributes specific to Gradle's plugin system.

Link copied to clipboard

Classes for configuring cache-related components.

Link copied to clipboard

Classes for dealing with capabilities.

Link copied to clipboard

Types for declaring and using Software Components.

Link copied to clipboard

Classes related to build configuration.

Link copied to clipboard

general credentials related classes.

Link copied to clipboard

The main interfaces and classes of the distribution plugin.

Link copied to clipboard

The distribution plugin itself.

Link copied to clipboard

Classes for managing and monitoring build execution.

Link copied to clipboard

Classes for working with files.

Link copied to clipboard

Gradle Flow API.

Link copied to clipboard

Classes for managing and monitoring build initialization.

Link copied to clipboard

Types related to the build definition for included builds.

Link copied to clipboard

Classes used in the initialization DSL.

Link copied to clipboard

Classes for managing cross-project dependency resolution.

Link copied to clipboard

Classes for invoking and monitoring gradle builds.

Link copied to clipboard

Classes for working with JAR manifests.

Link copied to clipboard

Interfaces for configuring the Java Platform Module System (JPMS).

Link copied to clipboard

Interfaces for configuring the cli client.

Link copied to clipboard

Classes for managing logging in Gradle.

Link copied to clipboard

Classes for logging configuration.

Link copied to clipboard

Classes that operate on the Gradle model.

Link copied to clipboard

The standard org.gradle.api.Plugin implementations.

Link copied to clipboard

A org.gradle.api.Plugin for generating parsers from Antlr grammars.

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

Plugins which measure and enforce code quality.

Link copied to clipboard

A org.gradle.api.Plugin which compiles and tests Scala sources.

Link copied to clipboard

new Problems API

Link copied to clipboard

The interfaces for value providers.

Link copied to clipboard

Classes that deal with publishing artifacts.

Link copied to clipboard

Types that deal with publishing in the Ivy format.

Link copied to clipboard

Plugins for Ivy publishing.

Link copied to clipboard

Tasks for Ivy publishing.

Link copied to clipboard

Types that deal with publishing in the Maven format.

Link copied to clipboard

Plugins for publishing in the Maven format.

Link copied to clipboard

Tasks for publishing in the Maven format.

Link copied to clipboard

Publishing plugin.

Link copied to clipboard

Tasks used for publishing to a binary repository.

Link copied to clipboard

Classes and API for the reflection and types.

Link copied to clipboard

Classes for reporting

Link copied to clipboard

Component reporting tasks.

Link copied to clipboard

Types responsible for generating dependency reports.

Link copied to clipboard

Types responsible for generating dependents components reports.

Link copied to clipboard

Configuration model reporting tasks.

Link copied to clipboard

Plugins for reporting

Link copied to clipboard

Interfaces and API for the 'Resources' concept.

Link copied to clipboard

Types for defining and using build services.

Link copied to clipboard

Classes for defining general purpose criteria.

Link copied to clipboard

The standard org.gradle.api.Task implementations.

Link copied to clipboard

The Ant integration org.gradle.api.Task implementations.

Link copied to clipboard
Link copied to clipboard

The archive bundling org.gradle.api.Task implementations.

Link copied to clipboard

The compilation org.gradle.api.Task implementations.

Link copied to clipboard

The diagnostic org.gradle.api.Task implementations.

Diagnostic tasks which report information about configurations.

Link copied to clipboard

API classes for implementing incremental tasks.

Link copied to clipboard

The documentation generation org.gradle.api.Task implementations.

Link copied to clipboard

Annotations for exposing task properties as command line options.

Link copied to clipboard
Link copied to clipboard

The unit testing org.gradle.api.Task implementations.

Link copied to clipboard

JUnit specific testing classes.

Link copied to clipboard

Types related to logging of test related information to the console.

Link copied to clipboard

TestNG specific testing classes.

Link copied to clipboard

Utility classes used by the standard task implementations.

Link copied to clipboard

The Gradle wrapper org.gradle.api.Task.

Link copied to clipboard

APIs to influence how toolchains are resolved.

Link copied to clipboard

Classes related to transport authentication protocols.

Link copied to clipboard

Classes related to transport authentication protocols for S3.

Link copied to clipboard

Classes related to transport authentication protocols for HTTP.

Link copied to clipboard

Types for receiving build events.

Link copied to clipboard

Build init plugins and tasks. This powers "gradle init".

Link copied to clipboard

Build init plugins.

Link copied to clipboard

Build init plugins.

Link copied to clipboard
Link copied to clipboard

Classes for configuring build caches.

Link copied to clipboard

Classes for HTTP build cache service.

Link copied to clipboard

Classes for local build cache services.

Link copied to clipboard

Classes related to Gradle parallelism and concurrency.

Link copied to clipboard

Classes to run Javadoc.

Link copied to clipboard

Model classes for visual studio.

Link copied to clipboard

Plugins for Visual Studio integration.

Link copied to clipboard

Task classes for visual studio.

Link copied to clipboard

Model classes for XCode.

Link copied to clipboard

Plugins for XCode integration.

Link copied to clipboard

Task classes for XCode.

Link copied to clipboard

Component types for Ivy modules.

Link copied to clipboard

Types for support of JVM runtime.

Link copied to clipboard

Classes that enable JVM application script generation.

Link copied to clipboard

Tasks for the JVM application plugin.

Link copied to clipboard

Tasks that add support for JVM runtime.

Link copied to clipboard

Defines tools that can build things that run on the JVM.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Model classes for managing language sources.

Link copied to clipboard

Model classes for building from Assembler language sources.

Link copied to clipboard

Plugins for building from Assembler language sources.

Link copied to clipboard

Tasks for assembling Assembler sources for a native runtime.

Link copied to clipboard

General purpose types for language support.

Link copied to clipboard

Classes representing artifacts relevant to languages in general.

Link copied to clipboard

General purpose types for related to compiling.

Link copied to clipboard

Base plugins for language support.

Link copied to clipboard

General purpose types for language sources support.

Link copied to clipboard

Model classes for building from C language sources.

Link copied to clipboard

Plugins for building from C language sources.

Link copied to clipboard

Tasks for compiling C sources for a native runtime.

Link copied to clipboard

Model classes for building from C++ language sources.

Link copied to clipboard

Plugins for building from C++ language sources.

Link copied to clipboard

Tasks for compiling C++ sources for a native runtime.

Link copied to clipboard

Classes representing artifacts relevant to the Java language.

Link copied to clipboard

Tasks for support for JVM languages.

Link copied to clipboard
Link copied to clipboard

Base classes for native language compile tasks.

Link copied to clipboard

Model classes for building from Objective-C language sources.

Link copied to clipboard

Plugins for building from Objective-C language sources.

Link copied to clipboard

Tasks for compiling Objective-C sources for a native runtime.

Link copied to clipboard

Model classes for building from Objective-C++ language sources.

Link copied to clipboard

Plugins for building from Objective-C++ language sources.

Link copied to clipboard

Tasks for compiling Objective-C++ sources for a native runtime.

Link copied to clipboard

Base plugins for the native languages.

Link copied to clipboard

Model classes for building from Windows Resource scripts.

Link copied to clipboard

Plugins for building from Windows Resource scripts.

Link copied to clipboard

Tasks for compiling Windows resources for a native runtime.

Link copied to clipboard

Tasks that add support for Scala language.

Link copied to clipboard

Model classes for building from Swift language sources.

Link copied to clipboard

Plugins for building from Swift language sources.

Link copied to clipboard

Tasks for compiling Swift sources for a native runtime.

Link copied to clipboard

Component types for Maven modules.

Link copied to clipboard

Classes that operate upon the Gradle model.

Link copied to clipboard

Classes that model aspects of native component projects.

Link copied to clipboard

Classes that allow defining a native binary platform.

Link copied to clipboard

Plugins for building native component projects.

Link copied to clipboard

Tasks for building native component projects.

Link copied to clipboard

API classes for testing native binaries.

Link copied to clipboard

API classes for C++ test integration.

Plugins for C++ test integration.

Link copied to clipboard

API classes for cunit integration.

Plugins for cunit testing.

Tasks for cunit integration.

API classes for Google Test integration.

Plugins for Google Test testing.

Link copied to clipboard

Plugin classes for generic support for testing native binaries.

Link copied to clipboard

Tasks for test execution.

Link copied to clipboard

Model classes for the XCTest plugins.

Plugins for XCTest testing.

Tasks for XCTest execution.

Link copied to clipboard

Classes that allow C++ tool chains to be configured.

Built-in tool chain support.

Link copied to clipboard

Interfaces and API for input normalization.

Link copied to clipboard

Types to define build environment.

Link copied to clipboard

General purpose types for runtime support.

Link copied to clipboard

General purpose types for binary support.

Link copied to clipboard

General purpose types for library support.

Link copied to clipboard

Base plugins for software model support.

Link copied to clipboard

Classes for assisting with plugin development.

Link copied to clipboard

Plugins for assisting with plugin development.

Link copied to clipboard

Tasks for assisting with plugin development.

Link copied to clipboard

APIs to influence how plugins are resolved.

Link copied to clipboard

Classes for managing plugin resolution and use.

Link copied to clipboard

Support for generating EAR archives in a Gradle build

Link copied to clipboard

Classes for working with EAR deployment descriptors.

Link copied to clipboard

General purpose IDE types.

Link copied to clipboard

General ide plugin api.

Link copied to clipboard

A org.gradle.api.Plugin for generating Eclipse files.

Link copied to clipboard

Classes for the model used by the eclipse plugins.

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

The signing plugin.

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

The signing plugin signature types.

Link copied to clipboard

PGP signing support.

Link copied to clipboard

Classes for executing system and Java processes.

Link copied to clipboard

Model classes that describe a Swift Package Manager package.

Link copied to clipboard

Plugins that produce Swift Package Manager manifests from the Gradle model.

Link copied to clipboard

Tasks that produce Swift Package Manager manifests from the Gradle model.

Link copied to clipboard
Link copied to clipboard

General purpose types for test suite support.

Link copied to clipboard
Link copied to clipboard

Plugins to work with the JaCoCo code coverage library.

Link copied to clipboard

Tasks to work with the JaCoCo code coverage library.

Link copied to clipboard

Implementations for Jacoco code coverage rules.

Link copied to clipboard

Support for executing contrived Gradle builds for the purpose of testing build logic.

Link copied to clipboard

The main interfaces and classes of the Gradle tooling API.

Link copied to clipboard

The interfaces and classes related to registering for event notifications and listening to dispatched events.

Link copied to clipboard

Project configuration specific interfaces and classes related to event notifications.

Link copied to clipboard

File download specific interfaces and classes related to event notifications.

Link copied to clipboard

Build lifecycle interfaces and classes related to event notifications.

Link copied to clipboard

Problem specific interfaces and classes related to event notifications.

Link copied to clipboard

Task execution specific interfaces and classes related to event notifications.

Link copied to clipboard

Task execution result interfaces specific to Java projects.

Link copied to clipboard

Test execution specific interfaces and classes related to event notifications.

Link copied to clipboard

Artifact transform execution specific interfaces and classes related to event notifications.

Link copied to clipboard

Work item execution specific interfaces and classes related to event notifications.

Link copied to clipboard

Exceptions thrown when using the tooling API.

Link copied to clipboard

The general-purpose tooling model types, provided by the tooling API.

Link copied to clipboard

Tooling models for the build environment, which includes information such as Gradle or Java versions.

Link copied to clipboard

Types that represent the tooling model for C++ projects.

Link copied to clipboard

Eclipse-centric tooling models.

Link copied to clipboard

The tooling models for Gradle builds and projects.

Link copied to clipboard

IntelliJ IDEA centric tooling models.

Link copied to clipboard

Java-specific details for tooling models.

Link copied to clipboard

Kotlin DSL related tooling models.

Link copied to clipboard

Interfaces and classes that allow tooling models to be made available to the tooling API client.

Link copied to clipboard
Link copied to clipboard

Packages for version control systems.

Link copied to clipboard

The API for dealing with Version Control Systems in Gradle.

Link copied to clipboard

Classes used for implementing units of work.

Link copied to clipboard

Workers allow running pieces of work in the background, either in-process in isolated classloaders or out-of-process in reusable daemons.