org.gradle
Class GradleLauncher

java.lang.Object
  org.gradle.GradleLauncher

public class GradleLauncher
extends java.lang.Object

GradleLauncher is the main entry point for embedding Gradle. You use this class to manage a Gradle build, as follows:

1. Optionally create a StartParameter instance and configure it with the desired properties. The properties of StartParameter generally correspond to the command-line options of Gradle. You can use createStartParameter(String[]) to create a StartParameter from a set of command-line options.
2. Obtain a GradleLauncher instance by calling newInstance(org.gradle.StartParameter), passing in the StartParameter, or an array of Strings that will be treated as command line arguments.
3. Optionally add one or more listeners to the GradleLauncher.
4. Call run() to execute the build. This will return a BuildResult. Note that if the build fails, the resulting exception will be contained in the BuildResult.
5. Query the build result. You might want to call BuildResult.rethrowFailure() to rethrow any build failure.

Constructor Summary

GradleLauncher(org.gradle.api.internal.GradleInternal gradle, org.gradle.initialization.InitScriptHandler initScriptHandler, org.gradle.initialization.SettingsHandler settingsHandler, org.gradle.initialization.IGradlePropertiesLoader gradlePropertiesLoader, org.gradle.initialization.BuildLoader buildLoader, org.gradle.configuration.BuildConfigurer buildConfigurer, org.gradle.initialization.LoggingConfigurer loggingConfigurer, org.gradle.listener.ListenerManager listenerManager)
Creates a new instance.

Method Summary

void	addListener(java.lang.Object listener) Adds a BuildListener to this build instance.
void	addStandardErrorListener(StandardOutputListener listener) Adds a StandardOutputListener to this build instance.
void	addStandardOutputListener(StandardOutputListener listener) Adds a StandardOutputListener to this build instance.
static StartParameter	createStartParameter(java.lang.String[] commandLineArgs) Returns a StartParameter object out of command line syntax arguments.
BuildResult	getBuildAnalysis() Evaluates the settings and all the projects.
BuildResult	getBuildAndRunAnalysis() Evaluates the settings and all the projects.
static void	injectCustomFactory(GradleFactory gradleFactory)
static GradleLauncher	newInstance(StartParameter startParameter) Returns a GradleLauncher instance based on the passed start parameter.
static GradleLauncher	newInstance(java.lang.String[] commandLineArgs) Returns a GradleLauncher instance based on the passed command line syntax arguments.
BuildResult	run() Executes the build for this GradleLauncher instance and returns the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

GradleLauncher

public GradleLauncher(org.gradle.api.internal.GradleInternal gradle,
                      org.gradle.initialization.InitScriptHandler initScriptHandler,
                      org.gradle.initialization.SettingsHandler settingsHandler,
                      org.gradle.initialization.IGradlePropertiesLoader gradlePropertiesLoader,
                      org.gradle.initialization.BuildLoader buildLoader,
                      org.gradle.configuration.BuildConfigurer buildConfigurer,
                      org.gradle.initialization.LoggingConfigurer loggingConfigurer,
                      org.gradle.listener.ListenerManager listenerManager)

Creates a new instance. Don't call this directly, use newInstance(StartParameter) or newInstance(String[]) instead. Note that this method is package-protected to discourage it's direct use.

Method Detail

run

public BuildResult run()

Executes the build for this GradleLauncher instance and returns the result. Note that when the build fails, the exception is available using BuildResult.getFailure().

Returns:

The result. Never returns null.

getBuildAnalysis

public BuildResult getBuildAnalysis()

Evaluates the settings and all the projects. The information about available tasks and projects is accessible via the Gradle.getRootProject() object.

Returns:

A BuildResult object. Never returns null.

getBuildAndRunAnalysis

public BuildResult getBuildAndRunAnalysis()

Evaluates the settings and all the projects. The information about available tasks and projects is accessible via the Gradle.getRootProject() object. Fills the execution plan without running the build. The tasks to be executed tasks are available via Gradle.getTaskGraph().

Returns:

A BuildResult object. Never returns null.

newInstance

public static GradleLauncher newInstance(StartParameter startParameter)

Returns a GradleLauncher instance based on the passed start parameter.

Parameters:

startParameter - The start parameter object the GradleLauncher instance is initialized with

newInstance

public static GradleLauncher newInstance(java.lang.String[] commandLineArgs)

Returns a GradleLauncher instance based on the passed command line syntax arguments. Certain command line arguments won't have any effect if you choose this method (e.g. -v, -h). If you want to act upon, you better use createStartParameter(String[]) in conjunction with newInstance(String[]).

Parameters:

commandLineArgs - A String array where each element denotes an entry of the Gradle command line syntax

createStartParameter

public static StartParameter createStartParameter(java.lang.String[] commandLineArgs)

Returns a StartParameter object out of command line syntax arguments. Every possible command line option has it associated field in the StartParameter object.

Parameters:

commandLineArgs - A String array where each element denotes an entry of the Gradle command line syntax

injectCustomFactory

public static void injectCustomFactory(GradleFactory gradleFactory)

addListener

public void addListener(java.lang.Object listener)

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

Parameters:

listener - The listener to add. Has no effect if the listener has already been added.

addStandardOutputListener

public void addStandardOutputListener(StandardOutputListener listener)

Adds a StandardOutputListener to this build instance. The listener is notified of any text written to standard output by Gradle's logging system

Parameters:

listener - The listener to add. Has no effect if the listener has already been added.

addStandardErrorListener

public void addStandardErrorListener(StandardOutputListener listener)

Adds a StandardOutputListener to this build instance. The listener is notified of any text written to standard error by Gradle's logging system

Parameters:

listener - The listener to add. Has no effect if the listener has already been added.