Gradle

addBuildListener

Adds a BuildListener to this Build instance. The listener is notified of events which occur during the execution of the build.

addListener

Adds the given listener to this build. The listener may implement any of the given listener interfaces:

• org.gradle.BuildListener
• org.gradle.api.execution.TaskExecutionGraphListener
• org.gradle.api.ProjectEvaluationListener
• org.gradle.api.execution.TaskExecutionListener
• org.gradle.api.execution.TaskActionListener
• org.gradle.api.logging.StandardOutputListener
• org.gradle.api.tasks.testing.TestListener
• org.gradle.api.tasks.testing.TestOutputListener
• org.gradle.api.artifacts.DependencyResolutionListener

addProjectEvaluationListener

Adds a listener to this build, to receive notifications as projects are evaluated.

afterProject

Adds a closure to be called immediately after a project is evaluated. The project is passed to the closure as the first parameter. The project evaluation failure, if any, is passed as the second parameter. Both parameters are optional.

Adds an action to be called immediately after a project is evaluated.

allprojects

Adds an action to execute against all projects of this build. The action is executed immediately against all projects which are already available. It is also executed as subsequent projects are added to this build.

beforeProject

Adds a closure to be called immediately before a project is evaluated. The project is passed to the closure as a parameter.

Adds an action to be called immediately before a project is evaluated.

buildFinished

Adds a closure to be called when the build is completed. All selected tasks have been executed. A BuildResult instance is passed to the closure as a parameter.

Adds an action to be called when the build is completed. All selected tasks have been executed.

buildStarted

Adds a closure to be called when the build is started. This Gradle instance is passed to the closure as the first parameter.

Adds an action to be called when the build is started.

getGradle

Returns this Gradle instance. This method is useful in init scripts to explicitly access Gradle properties and methods. For example, using gradle.parent can express your intent better than using parent. This property also allows you to access Gradle properties from a scope where the property may be hidden, such as, for example, from a method or closure.

getGradleHomeDir

Returns the Gradle home directory, if any. This directory is the directory containing the Gradle distribution executing this build.

When using the “Gradle Daemon”, this may not be the same Gradle distribution that the build was started with. If an existing daemon process is running that is deemed compatible (e.g. has the desired JVM characteristics) then this daemon may be used instead of starting a new process and it may have been started from a different “gradle home”. However, it is guaranteed to be the same version of Gradle. For more information on the Gradle Daemon, please consult the user guide.

getGradleUserHomeDir

Returns the Gradle user home directory. This directory is used to cache downloaded resources, compiled build scripts and so on.

getGradleVersion

Returns the current Gradle version.

getIncludedBuilds

Returns the included builds for this build.

getParent

Returns the parent build of this build, if any.

getRootProject

Returns the root project of this build.

getStartParameter

Returns the StartParameter used to start this build.

getTaskGraph

Returns the TaskExecutionGraph for this build.

includedBuild

Returns the included build with the specified name for this build.

projectsEvaluated

Adds a closure to be called when all projects for the build have been evaluated. The project objects are fully configured and are ready to use to populate the task graph. This Gradle instance is passed to the closure as a parameter.

Adds an action to be called when all projects for the build have been evaluated. The project objects are fully configured and are ready to use to populate the task graph.

projectsLoaded

Adds a closure to be called when the projects for the build have been created from the settings. None of the projects have been evaluated. This Gradle instance is passed to the closure as a parameter.

An example of hooking into the projectsLoaded to configure buildscript classpath from the init script.

 //init.gradle gradle.projectsLoaded { rootProject.buildscript { repositories { //... } dependencies { //... } } } 

Adds an action to be called when the projects for the build have been created from the settings. None of the projects have been evaluated.

removeListener

Removes the given listener from this build.

removeProjectEvaluationListener

Removes the given listener from this build.

rootProject

Adds an action to execute against the root project of this build. If the root project is already available, the action is executed immediately. Otherwise, the action is executed when the root project becomes available.

settingsEvaluated

Adds a closure to be called when the build settings have been loaded and evaluated. The settings object is fully configured and is ready to use to load the build projects. The org.gradle.api.initialization.Settings object is passed to the closure as a parameter.

Adds an action to be called when the build settings have been loaded and evaluated. The settings object is fully configured and is ready to use to load the build projects.

useLogger

Uses the given object as a logger. The logger object may implement any of the listener interfaces supported by #addListener(Object).

Each listener interface has exactly one associated logger. When you call this method with a logger of a given listener type, the new logger will replace whichever logger is currently associated with the listener type. This allows you to selectively replace the standard logging which Gradle provides with your own implementation, for certain types of events.

apply

Applies zero or more plugins or scripts.

The given closure is used to configure an ObjectConfigurationAction, which “builds” the plugin application.

This method differs from #apply(java.util.Map) in that it allows methods of the configuration action to be invoked more than once.

Applies a plugin or script, using the given options provided as a map. Does nothing if the plugin has already been applied.

The given map is applied as a series of method calls to a newly created ObjectConfigurationAction. That is, each key in the map is expected to be the name of a method ObjectConfigurationAction and the value to be compatible arguments to that method.

The following options are available:

• from: A script to apply. Accepts any path supported by org.gradle.api.Project#uri(Object).
• plugin: The id or implementation class of the plugin to apply.
• to: The target delegate object or objects. The default is this plugin aware object. Use this to configure objects other than this object.

getPluginManager

The plugin manager for this plugin aware object.

getPlugins

The container of plugins that have been applied to this object.

While not deprecated, it is preferred to use the methods of this interface or the plugin manager than use the plugin container.

Use one of the 'apply' methods on this interface or on the plugin manager to apply plugins instead of applying via the plugin container.

Use PluginManager#hasPlugin(String) or similar to query for the application of plugins instead of doing so via the plugin container.

apply

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

InitScriptApi

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