org.gradle.invocation

Class DefaultGradle

java.lang.Object

org.gradle.invocation.DefaultGradle

All Implemented Interfaces:

GradleInternal, Gradle

public class DefaultGradle
extends Object
implements GradleInternal

Constructor Summary

Constructors

Constructor and Description
DefaultGradle(Gradle parent, StartParameter startParameter, ServiceRegistryFactory parentRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
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<? super Project> 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.
BuildListener	getBuildListenerBroadcaster() Returns the broadcaster for BuildListener events
ProjectInternal	getDefaultProject() Returns the default project.
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.
ProjectEvaluationListener	getProjectEvaluationBroadcaster() Returns the broadcaster for ProjectEvaluationListener events for this build
IProjectRegistry<ProjectInternal>	getProjectRegistry()
ProjectInternal	getRootProject() Returns the root project of this build.
MultiParentClassLoader	getScriptClassLoader() Returns the root ClassLoader to use for the scripts of this build.
ServiceRegistryFactory	getServices()
StartParameter	getStartParameter() Returns the StartParameter used to start this build.
TaskGraphExecuter	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<? super Project> action) Adds an action to execute against the root project of this build.
void	setDefaultProject(ProjectInternal defaultProject) Called by the BuildLoader after the default project is determined.
void	setRootProject(ProjectInternal rootProject) Called by the BuildLoader after the root project is determined.
void	setTaskGraph(TaskGraphExecuter taskGraph)
void	settingsEvaluated(Closure closure) Adds a closure to be called when the build settings have been loaded and evaluated.
String	toString()
void	useLogger(Object logger) Uses the given object as a logger.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultGradle

public DefaultGradle(Gradle parent,
             StartParameter startParameter,
             ServiceRegistryFactory parentRegistry)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getParent

public Gradle getParent()

Description copied from interface: Gradle

Returns the parent build of this build, if any.

Specified by:

getParent in interface Gradle

Returns:

The parent build. May return null.

getGradleVersion

public String getGradleVersion()

Description copied from interface: Gradle

Returns the current Gradle version.

Specified by:

getGradleVersion in interface Gradle

Returns:

The Gradle version. Never returns null.

getGradleHomeDir

public File getGradleHomeDir()

Description copied from interface: Gradle

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

Specified by:

getGradleHomeDir in interface Gradle

Returns:

The home directory. May return null.

getGradleUserHomeDir

public File getGradleUserHomeDir()

Description copied from interface: Gradle

Returns the Gradle user home directory. This directory is used to cache downloaded resources.

Specified by:

getGradleUserHomeDir in interface Gradle

Returns:

The user home directory. Never returns null.

getStartParameter

public StartParameter getStartParameter()

Description copied from interface: Gradle

Returns the StartParameter used to start this build.

Specified by:

getStartParameter in interface Gradle

Returns:

The start parameter. Never returns null.

getRootProject

public ProjectInternal getRootProject()

Description copied from interface: GradleInternal

Returns the root project of this build.

Specified by:

getRootProject in interface GradleInternal

Specified by:

getRootProject in interface Gradle

Returns:

The root project. Never returns null.

setRootProject

public void setRootProject(ProjectInternal rootProject)

Description copied from interface: GradleInternal

Called by the BuildLoader after the root project is determined. Until the BuildLoader is executed, GradleInternal.getRootProject() will return null.

Specified by:

setRootProject in interface GradleInternal

Parameters:

rootProject - The root project for this build.

rootProject

public void rootProject(Action<? super Project> action)

Description copied from interface: Gradle

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.

Specified by:

rootProject in interface Gradle

Parameters:

action - The action to execute.

allprojects

public void allprojects(Action<? super Project> action)

Description copied from interface: Gradle

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.

Specified by:

allprojects in interface Gradle

Parameters:

action - The action to execute.

getDefaultProject

public ProjectInternal getDefaultProject()

Description copied from interface: GradleInternal

Returns the default project. This is used to resolve relative names and paths provided on the UI.

Specified by:

getDefaultProject in interface GradleInternal

setDefaultProject

public void setDefaultProject(ProjectInternal defaultProject)

Description copied from interface: GradleInternal

Called by the BuildLoader after the default project is determined. Until the BuildLoader is executed, GradleInternal.getDefaultProject() will return null.

Specified by:

setDefaultProject in interface GradleInternal

Parameters:

defaultProject - The default project for this build.

getTaskGraph

public TaskGraphExecuter getTaskGraph()

Description copied from interface: GradleInternal

Returns the TaskExecutionGraph for this build.

Specified by:

getTaskGraph in interface GradleInternal

Specified by:

getTaskGraph in interface Gradle

Returns:

The task graph. Never returns null.

setTaskGraph

public void setTaskGraph(TaskGraphExecuter taskGraph)

getProjectRegistry

public IProjectRegistry<ProjectInternal> getProjectRegistry()

Specified by:

getProjectRegistry in interface GradleInternal

getScriptClassLoader

public MultiParentClassLoader getScriptClassLoader()

Description copied from interface: GradleInternal

Returns the root ClassLoader to use for the scripts of this build.

Specified by:

getScriptClassLoader in interface GradleInternal

addProjectEvaluationListener

public ProjectEvaluationListener addProjectEvaluationListener(ProjectEvaluationListener listener)

Description copied from interface: Gradle

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

Specified by:

addProjectEvaluationListener in interface Gradle

Parameters:

listener - The listener to add. Does nothing if this listener has already been added.

Returns:

The added listener.

removeProjectEvaluationListener

public void removeProjectEvaluationListener(ProjectEvaluationListener listener)

Description copied from interface: Gradle

Removes the given listener from this build.

Specified by:

removeProjectEvaluationListener in interface Gradle

Parameters:

listener - The listener to remove. Does nothing if this listener has not been added.

beforeProject

public void beforeProject(Closure closure)

Description copied from interface: Gradle

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

Specified by:

beforeProject in interface Gradle

Parameters:

closure - The closure to execute.

afterProject

public void afterProject(Closure closure)

Description copied from interface: Gradle

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.

Specified by:

afterProject in interface Gradle

Parameters:

closure - The closure to execute.

buildStarted

public void buildStarted(Closure closure)

Description copied from interface: Gradle

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

Specified by:

buildStarted in interface Gradle

Parameters:

closure - The closure to execute.

settingsEvaluated

public void settingsEvaluated(Closure closure)

Description copied from interface: Gradle

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.

Specified by:

settingsEvaluated in interface Gradle

Parameters:

closure - The closure to execute.

projectsLoaded

public void projectsLoaded(Closure closure)

Description copied from interface: Gradle

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 {
       //...
     }
   }
 }
 

Specified by:

projectsLoaded in interface Gradle

Parameters:

closure - The closure to execute.

projectsEvaluated

public void projectsEvaluated(Closure closure)

Description copied from interface: Gradle

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.

Specified by:

projectsEvaluated in interface Gradle

Parameters:

closure - The closure to execute.

buildFinished

public void buildFinished(Closure closure)

Description copied from interface: Gradle

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.

Specified by:

buildFinished in interface Gradle

Parameters:

closure - The closure to execute.

addListener

public void addListener(Object listener)

Description copied from interface: Gradle

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

• BuildListener
• TaskExecutionGraphListener
• ProjectEvaluationListener
• TaskExecutionListener
• TaskActionListener
• StandardOutputListener
• TestListener
• TestOutputListener
• DependencyResolutionListener

Specified by:

addListener in interface Gradle

Parameters:

listener - The listener to add. Does nothing if this listener has already been added.

removeListener

public void removeListener(Object listener)

Description copied from interface: Gradle

Removes the given listener from this build.

Specified by:

removeListener in interface Gradle

Parameters:

listener - The listener to remove. Does nothing if this listener has not been added.

useLogger

public void useLogger(Object logger)

Description copied from interface: Gradle

Uses the given object as a logger. The logger object may implement any of the listener interfaces supported by Gradle.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.

Specified by:

useLogger in interface Gradle

Parameters:

logger - The logger to use.

getProjectEvaluationBroadcaster

public ProjectEvaluationListener getProjectEvaluationBroadcaster()

Description copied from interface: GradleInternal

Returns the broadcaster for ProjectEvaluationListener events for this build

Specified by:

getProjectEvaluationBroadcaster in interface GradleInternal

addBuildListener

public void addBuildListener(BuildListener buildListener)

Description copied from interface: Gradle

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

Specified by:

addBuildListener in interface Gradle

Parameters:

buildListener - The listener to add.

getBuildListenerBroadcaster

public BuildListener getBuildListenerBroadcaster()

Description copied from interface: GradleInternal

Returns the broadcaster for BuildListener events

Specified by:

getBuildListenerBroadcaster in interface GradleInternal

getGradle

public Gradle getGradle()

Description copied from interface: Gradle

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.

Specified by:

getGradle in interface Gradle

Returns:

this. Never returns null.

getServices

public ServiceRegistryFactory getServices()

Specified by:

getServices in interface GradleInternal