|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.gradle.GradleLauncher
public abstract class GradleLauncher
GradleLauncher
is the main entry point for embedding Gradle. You use this class to manage a Gradle build,
as follows:
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.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.GradleLauncher
.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
.BuildResult.rethrowFailure()
to rethrow any build
failure.
Constructor Summary | |
---|---|
GradleLauncher()
|
Method Summary | |
---|---|
abstract void |
addListener(Object listener)
Adds a listener to this build instance. |
abstract void |
addStandardErrorListener(StandardOutputListener listener)
Adds a StandardOutputListener to this build instance. |
abstract void |
addStandardOutputListener(StandardOutputListener listener)
Adds a StandardOutputListener to this build instance. |
static StartParameter |
createStartParameter(String... commandLineArgs)
Returns a StartParameter object out of command line syntax arguments. |
abstract BuildResult |
getBuildAnalysis()
Evaluates the settings and all the projects. |
abstract BuildResult |
getBuildAndRunAnalysis()
Evaluates the settings and all the projects. |
static org.gradle.initialization.GradleLauncherFactory |
getFactory()
|
static void |
injectCustomFactory(org.gradle.initialization.GradleLauncherFactory gradleLauncherFactory)
|
static GradleLauncher |
newInstance(StartParameter startParameter)
Returns a GradleLauncher instance based on the passed start parameter. |
static GradleLauncher |
newInstance(String... commandLineArgs)
Returns a GradleLauncher instance based on the passed command line syntax arguments. |
abstract BuildResult |
run()
Executes the build for this GradleLauncher instance and returns the result. |
abstract void |
useLogger(Object logger)
Use the given listener. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GradleLauncher()
Method Detail |
---|
public abstract 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()
.
public abstract BuildResult getBuildAnalysis()
Gradle.getRootProject()
object.
public abstract BuildResult getBuildAndRunAnalysis()
Gradle.getRootProject()
object. Fills the execution plan without running
the build. The tasks to be executed tasks are available via Gradle.getTaskGraph()
.
public static GradleLauncher newInstance(StartParameter startParameter)
GradleLauncher
instance based on the passed start parameter.
startParameter
- The start parameter object the GradleLauncher instance is initialized with
GradleLauncher
. Never returns null.public static org.gradle.initialization.GradleLauncherFactory getFactory()
public static GradleLauncher newInstance(String... commandLineArgs)
GradleLauncher
instance based on the passed command line syntax arguments.
commandLineArgs
- A String array where each element denotes an entry of the Gradle command line syntax
GradleLauncher
. Never returns null.public static StartParameter createStartParameter(String... commandLineArgs)
StartParameter
object out of command line syntax arguments. Each command line option has an
associated field in the StartParameter
object.
commandLineArgs
- A String array where each element denotes an entry of the Gradle command line syntax
GradleLauncher
. Never returns null.public static void injectCustomFactory(org.gradle.initialization.GradleLauncherFactory gradleLauncherFactory)
public abstract void addListener(Object listener)
Adds a listener to this build instance. The listener is notified of events which occur during the execution of
the build. See Gradle.addListener(Object)
for supported listener types.
listener
- The listener to add. Has no effect if the listener has already been added.public abstract void useLogger(Object logger)
Gradle.useLogger(Object)
for details.
logger
- The logger to use.public abstract 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
listener
- The listener to add. Has no effect if the listener has already been added.public abstract 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
listener
- The listener to add. Has no effect if the listener has already been added.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |