org.gradle.openapi.external.runner

Interface GradleRunnerInteractionVersion1

public interface GradleRunnerInteractionVersion1

.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GradleRunnerInteractionVersion1.LogLevel
static class	GradleRunnerInteractionVersion1.StackTraceLevel

Method Summary

Methods

Modifier and Type	Method and Description
File	getCustomGradleExecutable() This is called to get a custom gradle executable file.
GradleRunnerInteractionVersion1.LogLevel	getLogLevel()
GradleRunnerInteractionVersion1.StackTraceLevel	getStackTraceLevel()
File	getWorkingDirectory()
void	reportExecutionFinished(boolean wasSuccessful, String message, Throwable throwable)
void	reportExecutionStarted() Notification that overall execution has been started.
void	reportLiveOutput(String output) Report real-time output from gradle and its subsystems (such as ant).
void	reportNumberOfTasksToExecute(int size) Notification of the total number of tasks that will be executed.
void	reportTaskComplete(String currentTaskName, float percentComplete)
void	reportTaskStarted(String currentTaskName, float percentComplete) Notification that a single task has completed.

Method Detail

getWorkingDirectory

File getWorkingDirectory()

Returns:

The root directory of your gradle project. The same directory Where you would run gradle from the command.

getLogLevel

GradleRunnerInteractionVersion1.LogLevel getLogLevel()

Returns:

the log level. This determines the detail level of information reported via reportLiveOutput and reportExecutionFinished.

getStackTraceLevel

GradleRunnerInteractionVersion1.StackTraceLevel getStackTraceLevel()

Returns:

the stack trace level. This determines the detail level of any stack traces should an exception occur.

reportExecutionStarted

void reportExecutionStarted()

Notification that overall execution has been started. This is only called once at the end.

reportNumberOfTasksToExecute

void reportNumberOfTasksToExecute(int size)

Notification of the total number of tasks that will be executed. This is called after reportExecutionStarted and before any tasks are executed.

Parameters:

size - the total number of tasks.

reportTaskStarted

void reportTaskStarted(String currentTaskName,
                     float percentComplete)

Notification that a single task has completed. Note: the task you kicked off probably executes other tasks and this notifies you of those tasks and provides completion progress.

Parameters:

currentTaskName - the task being executed

percentComplete - the percent complete of all the tasks that make up the task you requested.

reportTaskComplete

void reportTaskComplete(String currentTaskName,
                      float percentComplete)

reportLiveOutput

void reportLiveOutput(String output)

Report real-time output from gradle and its subsystems (such as ant).

Parameters:

output - a single line of text to show.

reportExecutionFinished

void reportExecutionFinished(boolean wasSuccessful,
                           String message,
                           Throwable throwable)

getCustomGradleExecutable

File getCustomGradleExecutable()

This is called to get a custom gradle executable file. If you don't run gradle.bat or gradle shell script to run gradle, use this to specify what you do run. Note: we're going to pass it the arguments that we would pass to gradle so if you don't like that, see alterCommandLineArguments. Normaly, this should return null.

Returns:

the Executable to run gradle command or null to use the default