org.gradle.openapi.external.foundation

Interface RequestVersion1

All Known Implementing Classes:

RequestWrapper

public interface RequestVersion1

This represents an execution or refresh request sent to Gradle. Execution requests are just Gradle commands (what would be the command line arguments). A refresh request is what updates the task tree. This is a mirror of Request inside Gradle, but this is meant to aid backward and forward compatibility by shielding you from direct changes within gradle.

Author:

mhunsicker

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXECUTION_TYPE
static String	REFRESH_TYPE
static String	UNKNOWN_TYPE_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancels this request.
boolean	forceOutputToBeShown()
String	getDisplayName()
String	getFullCommandLine()
String	getType()

Field Detail

EXECUTION_TYPE

static final String EXECUTION_TYPE

See Also:

Constant Field Values

REFRESH_TYPE

static final String REFRESH_TYPE

See Also:

Constant Field Values

UNKNOWN_TYPE_PREFIX

static final String UNKNOWN_TYPE_PREFIX

See Also:

Constant Field Values

Method Detail

getFullCommandLine

String getFullCommandLine()

Returns:

the full gradle command line of this request

getDisplayName

String getDisplayName()

Returns:

the display name of this request. Often this is the same as the full command line, but favorites may specify something more user-friendly.

forceOutputToBeShown

boolean forceOutputToBeShown()

Returns:

whether or not output should always be shown. If false, only show it when errors occur.

cancel

boolean cancel()

Cancels this request.

getType

String getType()

Returns:

the type of the request. Either EXECUTION, REFRESH, or something that starts with UNKNOWN_TYPE_PREFIX (followed by an internal identifier) if its not listed above.