api / org.gradle.plugin.use / PluginDependencySpec

PluginDependencySpec

@Incubating interface PluginDependencySpec

A mutable specification of a dependency on a plugin.

Can be used to specify the version of the plugin to use.

See PluginDependenciesSpec for more information about declaring plugin dependencies.

Functions

apply

abstract fun 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.

This is useful when reusing classes from a plugin or to apply a plugin to sub-projects:

 plugins { id "org.company.myplugin" version "1.0" apply false } subprojects { if (someCondition) { apply plugin: "org.company.myplugin" } } 

version

abstract fun version(version: String): PluginDependencySpec

Specify the version of the plugin to depend on.

 plugins { id "org.company.myplugin" version "1.0" } 

By default, dependencies have no (i.e. null) version.

Core plugins must not include a version number specification. Community plugins must include a version number specification.

Extension Functions

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.

version

infix fun PluginDependencySpec.version(version: String?): PluginDependencySpec

Specify the version of the plugin to depend on.