org.gradle.openapi.wrappers.runner

Class GradleRunnerInteractionWrapper

java.lang.Object

org.gradle.openapi.wrappers.runner.GradleRunnerInteractionWrapper

All Implemented Interfaces:

ExecuteGradleCommandServerProtocol.ExecutionInteraction

public class GradleRunnerInteractionWrapper
extends java.lang.Object
implements ExecuteGradleCommandServerProtocol.ExecutionInteraction

Wrapper to shield version changes in GradleRunnerInteractionVersion1 from an external user of gradle open API.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
GradleRunnerInteractionWrapper(GradleRunnerInteractionVersion1 interactionVersion1)

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	getCustomGradleExecutable()
LogLevel	getLogLevel()
ShowStacktrace	getStackTraceLevel()
void	reportExecutionFinished(boolean wasSuccessful, java.lang.String message, java.lang.Throwable throwable) Notification that execution has finished.
void	reportExecutionStarted() Notification that overall execution has been started.
void	reportLiveOutput(java.lang.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(java.lang.String currentTaskName, float percentComplete)
void	reportTaskStarted(java.lang.String currentTaskName, float percentComplete) Notification that a single task has completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

GradleRunnerInteractionWrapper

public GradleRunnerInteractionWrapper(GradleRunnerInteractionVersion1 interactionVersion1)

Method Detail

getLogLevel

public LogLevel getLogLevel()

Returns:

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

getStackTraceLevel

public ShowStacktrace getStackTraceLevel()

Returns:

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

reportExecutionStarted

public void reportExecutionStarted()

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

Specified by:

reportExecutionStarted in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

reportNumberOfTasksToExecute

public 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.

Specified by:

reportNumberOfTasksToExecute in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

Parameters:

size - the total number of tasks.

reportTaskStarted

public void reportTaskStarted(java.lang.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.

Specified by:

reportTaskStarted in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

Parameters:

currentTaskName - the task being executed

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

reportTaskComplete

public void reportTaskComplete(java.lang.String currentTaskName,
                      float percentComplete)

Specified by:

reportTaskComplete in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

reportLiveOutput

public void reportLiveOutput(java.lang.String output)

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

Specified by:

reportLiveOutput in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

Parameters:

output - a single line of text to show.

reportExecutionFinished

public void reportExecutionFinished(boolean wasSuccessful,
                           java.lang.String message,
                           java.lang.Throwable throwable)

Description copied from interface: ExecuteGradleCommandServerProtocol.ExecutionInteraction

Notification that execution has finished. Note: if the client fails to launch at all, this should still be called.

Specified by:

reportExecutionFinished in interface ExecuteGradleCommandServerProtocol.ExecutionInteraction

Parameters:

wasSuccessful - true if gradle was successful (returned 0)

message - the output of gradle if it ran. If it didn't, an error message.

throwable - an exception if one occurred

getCustomGradleExecutable

public java.io.File getCustomGradleExecutable()