|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD |
org.gradle.tooling.BuildLauncherorg.gradle.tooling.LongRunningOperation
public interface BuildLauncher extends LongRunningOperation
A BuildLauncher allows you to configure and execute a Gradle build.
Instances of BuildLauncher are not thread-safe. You use a BuildLauncher as follows:
ProjectConnection connection = GradleConnector.newConnector() .forProjectDirectory(new File("someFolder")) .connect(); try { BuildLauncher build = connection.newBuild(); //select tasks to run: build.forTasks("clean", "test"); //configure the standard input: build.setStandardInput(new ByteArrayInputStream("consume this!".getBytes())); //in case you want the build to use java different than default: build.setJavaHome(new File("/path/to/java")); //if your build needs crazy amounts of memory: build.setJvmArguments("-Xmx2048m", "-XX:MaxPermSize=512m"); //if you want to listen to the progress events: ProgressListener listener = null; // use your implementation build.addProgressListener(listener); //kick the build off: build.run(); } finally { connection.close(); }
Method Summary | |
---|---|
BuildLauncher
|
addProgressListener(ProgressListener listener)
{@inheritDoc} |
BuildLauncher
|
forTasks(String... tasks)
Sets the tasks to be executed. |
BuildLauncher
|
forTasks(Task... tasks)
Sets the tasks to be executed. |
BuildLauncher
|
forTasks(Iterable tasks)
Sets the tasks to be executed. |
void
|
run()
Execute the build, blocking until it is complete. |
void
|
run(ResultHandler handler)
Launchers the build. |
BuildLauncher
|
setJavaHome(File javaHome)
{@inheritDoc} |
BuildLauncher
|
setJvmArguments(String... jvmArguments)
{@inheritDoc} |
BuildLauncher
|
setStandardError(OutputStream outputStream)
{@inheritDoc} |
BuildLauncher
|
setStandardInput(InputStream inputStream)
{@inheritDoc} |
BuildLauncher
|
setStandardOutput(OutputStream outputStream)
{@inheritDoc} |
Methods inherited from interface LongRunningOperation | |
---|---|
addProgressListener, setJavaHome, setJvmArguments, setStandardError, setStandardInput, setStandardOutput |
Method Detail |
---|
public BuildLauncher addProgressListener(ProgressListener listener)
public BuildLauncher forTasks(String... tasks)
tasks
- The paths of the tasks to be executed. Relative paths are evaluated relative to the project for which this launcher was created.
public BuildLauncher forTasks(Task... tasks)
tasks
- The tasks to be executed.
public BuildLauncher forTasks(Iterable tasks)
tasks
- The tasks to be executed.
public void run()
public void run(ResultHandler handler)
handler
- The handler to supply the result to.
public BuildLauncher setJavaHome(File javaHome)
public BuildLauncher setJvmArguments(String... jvmArguments)
public BuildLauncher setStandardError(OutputStream outputStream)
public BuildLauncher setStandardInput(InputStream inputStream)
public BuildLauncher setStandardOutput(OutputStream outputStream)
Gradle API 1.0-milestone-9