org.gradle.gradleplugin.foundation.request

Interface Request

All Superinterfaces:

ExecutionQueue.Request

All Known Implementing Classes:

AbstractRequest, ExecutionRequest, RefreshTaskListRequest

public interface Request
extends ExecutionQueue.Request

This represents a reques to gradle that is executed in a separate process using the ProcessLauncherServer.

Author:

mhunsicker

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.foundation.queue.ExecutionQueue.Request

ExecutionQueue.Request.Type

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancels this request.
ProcessLauncherServer.Protocol	createServerProtocol(LogLevel logLevel, ShowStacktrace stackTraceLevel, File currentDirectory, File gradleHomeDirectory, File customGradleExecutor) This is called right before this command is executed (because the settings such as log level and stack trace level can be changed between the time someone initiates a command and it executes).
void	executeAgain(GradlePluginLord gradlePluginLord)
boolean	forceOutputToBeShown()
String	getDisplayName()
String	getFullCommandLine()
long	getRequestID()
void	setExecutionInteraction(ExecuteGradleCommandServerProtocol.ExecutionInteraction executionInteraction)
void	setProcessLauncherServer(ProcessLauncherServer server) This is called internally to link the request with the server that is running the gradle process.

Methods inherited from interface org.gradle.foundation.queue.ExecutionQueue.Request

getType

Method Detail

getRequestID

long getRequestID()

getFullCommandLine

String getFullCommandLine()

getDisplayName

String getDisplayName()

forceOutputToBeShown

boolean forceOutputToBeShown()

setProcessLauncherServer

void setProcessLauncherServer(ProcessLauncherServer server)

This is called internally to link the request with the server that is running the gradle process.

Parameters:

server - the server.

cancel

boolean cancel()

Cancels this request.

Returns:

true if you can cancel or it or if it has already ran. This return code is mainly meant to prevent you from

setExecutionInteraction

void setExecutionInteraction(ExecuteGradleCommandServerProtocol.ExecutionInteraction executionInteraction)

createServerProtocol

ProcessLauncherServer.Protocol createServerProtocol(LogLevel logLevel,
                                                  ShowStacktrace stackTraceLevel,
                                                  File currentDirectory,
                                                  File gradleHomeDirectory,
                                                  File customGradleExecutor)

This is called right before this command is executed (because the settings such as log level and stack trace level can be changed between the time someone initiates a command and it executes). The execution takes place in another process so this should create the appropriate Protocol suitable for passing the results of the execution back to us.

Parameters:

logLevel - the user's log level.

stackTraceLevel - the user's stack trace level

currentDirectory - the current working directory of your gradle project

gradleHomeDirectory - the gradle home directory

customGradleExecutor - the path to a custom gradle executable. May be null.

Returns:

a protocol that our server will use to communicate with the launched gradle process.

executeAgain

void executeAgain(GradlePluginLord gradlePluginLord)