Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

org.gradle.api.invocation
[Java] Interface Gradle

org.gradle.api.plugins.PluginAware
  org.gradle.api.invocation.Gradle
All Superinterfaces:
PluginAware
@HasInternalProtocol
public interface Gradle
extends PluginAware

Represents an invocation of Gradle.

You can obtain a Gradle instance by calling Project#getGradle()#getGradle().

Method Summary
void addBuildListener(BuildListener buildListener)

Adds a BuildListener to this Build instance.
void addListener(Object listener)

Adds the given listener to this build.

ProjectEvaluationListener addProjectEvaluationListener(ProjectEvaluationListener listener)

Adds a listener to this build, to receive notifications as projects are evaluated.
void afterProject(Closure closure)

Adds a closure to be called immediately after a project is evaluated.
void allprojects(Action action)

Adds an action to execute against all projects of this build.
void beforeProject(Closure closure)

Adds a closure to be called immediately before a project is evaluated.

void buildFinished(Closure closure)

Adds a closure to be called when the build is completed.
void buildStarted(Closure closure)

Adds a closure to be called when the build is started.
Gradle getGradle()

Returns this Gradle instance.
File getGradleHomeDir()

Returns the Gradle home directory, if any.
File getGradleUserHomeDir()

Returns the Gradle user home directory.
String getGradleVersion()

Returns the current Gradle version.
Gradle getParent()

Returns the parent build of this build, if any.
Project getRootProject()

Returns the root project of this build.
StartParameter getStartParameter()

Returns the StartParameter used to start this build.
TaskExecutionGraph getTaskGraph()

Returns the TaskExecutionGraph for this build.
void projectsEvaluated(Closure closure)

Adds a closure to be called when all projects for the build have been evaluated.
void projectsLoaded(Closure closure)

Adds a closure to be called when the projects for the build have been created from the settings.
void removeListener(Object listener)

Removes the given listener from this build.
void removeProjectEvaluationListener(ProjectEvaluationListener listener)

Removes the given listener from this build.
void rootProject(Action action)

Adds an action to execute against the root project of this build.
void settingsEvaluated(Closure closure)

Adds a closure to be called when the build settings have been loaded and evaluated.
void useLogger(Object logger)

Uses the given object as a logger.
 
Methods inherited from interface PluginAware
apply, apply, getPlugins
 

Method Detail

addBuildListener

public void addBuildListener(BuildListener buildListener)
Adds a BuildListener to this Build instance. The listener is notified of events which occur during the execution of the build.
Parameters:
buildListener - The listener to add.

addListener

public void addListener(Object listener)
Adds the given listener to this build. The listener may implement any of the given listener interfaces:
Parameters:
listener - The listener to add. Does nothing if this listener has already been added.

addProjectEvaluationListener

public ProjectEvaluationListener addProjectEvaluationListener(ProjectEvaluationListener listener)
Adds a listener to this build, to receive notifications as projects are evaluated.
Parameters:
listener - The listener to add. Does nothing if this listener has already been added.
Returns:
The added listener.

afterProject

public void afterProject(Closure closure)
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.
Parameters:
closure - The closure to execute.

allprojects

public void allprojects(Action action)
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.
Parameters:
action - The action to execute.

beforeProject

public void beforeProject(Closure closure)
Adds a closure to be called immediately before a project is evaluated. The project is passed to the closure as a parameter.
Parameters:
closure - The closure to execute.

buildFinished

public void buildFinished(Closure closure)
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.
Parameters:
closure - The closure to execute.

buildStarted

public void buildStarted(Closure closure)
Adds a closure to be called when the build is started. This Gradle instance is passed to the closure as the first parameter.
Parameters:
closure - The closure to execute.

getGradle

public Gradle 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.
Returns:
this. Never returns null.

getGradleHomeDir

public File 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.

Returns:
The home directory. May return null.

getGradleUserHomeDir

public File getGradleUserHomeDir()
Returns the Gradle user home directory. This directory is used to cache downloaded resources, compiled build scripts and so on.
Returns:
The user home directory. Never returns null.

getGradleVersion

public String getGradleVersion()
Returns the current Gradle version.
Returns:
The Gradle version. Never returns null.

getParent

public Gradle getParent()
Returns the parent build of this build, if any.
Returns:
The parent build. May return null.

getRootProject

public Project getRootProject()
Returns the root project of this build.
throws:
IllegalStateException When called before the root project is available.
Returns:
The root project. Never returns null.

getStartParameter

public StartParameter getStartParameter()
Returns the StartParameter used to start this build.
Returns:
The start parameter. Never returns null.

getTaskGraph

public TaskExecutionGraph getTaskGraph()
Returns the TaskExecutionGraph for this build.
Returns:
The task graph. Never returns null.

projectsEvaluated

public void projectsEvaluated(Closure closure)
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.
Parameters:
closure - The closure to execute.

projectsLoaded

public void projectsLoaded(Closure closure)
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 {
       //...
     }
   }
 }
Parameters:
closure - The closure to execute.

removeListener

public void removeListener(Object listener)
Removes the given listener from this build.
Parameters:
listener - The listener to remove. Does nothing if this listener has not been added.

removeProjectEvaluationListener

public void removeProjectEvaluationListener(ProjectEvaluationListener listener)
Removes the given listener from this build.
Parameters:
listener - The listener to remove. Does nothing if this listener has not been added.

rootProject

public void rootProject(Action action)
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.
Parameters:
action - The action to execute.

settingsEvaluated

public void settingsEvaluated(Closure closure)
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 Settings object is passed to the closure as a parameter.
Parameters:
closure - The closure to execute.

useLogger

public void useLogger(Object logger)
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.

Parameters:
logger - The logger to use.

 

Gradle API 1.12