api / org.gradle.api.plugins / PluginManager

PluginManager

@Incubating @NonExtensible interface PluginManager

Facilitates applying plugins and determining which plugins have been applied to a PluginAware object.

See Also
PluginAware

Since
2.3

Functions

apply

abstract fun apply(pluginId: String): Unit

Applies the plugin with the given ID. Does nothing if the plugin has already been applied.

Plugins in the "org.gradle" namespace can be applied directly via name. That is, the following two lines are equivalent…

 pluginManager.apply "org.gradle.java" pluginManager.apply "java" 

abstract fun apply(type: Class<*>): Unit

Applies the given plugin. Does nothing if the plugin has already been applied.

The given class should implement the org.gradle.api.Plugin interface, and be parameterized for a compatible type of this.

The following two lines are equivalent…

 pluginManager.apply org.gradle.api.plugins.JavaPlugin pluginManager.apply "org.gradle.java" 

findPlugin

abstract fun findPlugin(id: String): AppliedPlugin

Returns the information about the plugin that has been applied with the given ID, or null if no plugin has been applied with the given ID.

Plugins in the "org.gradle" namespace (that is, core Gradle plugins) can be specified by either name (e.g. "java") or ID "org.gradle.java". All other plugins must be queried for by their full ID (e.g. "org.company.some-plugin").

Some Gradle plugins have not yet migrated to fully qualified plugin IDs. Such plugins can be detected with this method by simply using the unqualified ID (e.g. "some-third-party-plugin".

hasPlugin

abstract fun hasPlugin(id: String): Boolean

Returns true if a plugin with the given ID has already been applied, otherwise false.

withPlugin

abstract fun withPlugin(id: String, action: Action<in AppliedPlugin>): Unit

Executes the given action when the specified plugin is applied.

If a plugin with the specified ID has already been applied, the supplied action will be executed immediately. Otherwise, the action will executed immediately after a plugin with the specified ID is applied.

The given action is always executed after the plugin has been applied.