Package com.intellij.openapi.externalSystem.model.task

Interface ExternalSystemTaskNotificationListener

All Known Implementing Classes:

ExternalSystemProcessingManager, ExternalSystemTaskNotificationListenerAdapter, GradleMavenProjectImportNotificationListener, GradleProjectImportNotificationListener

public interface ExternalSystemTaskNotificationListener

Defines contract for callback to listen external task notifications.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ExternalSystemTaskNotificationListener>	EP_NAME

Method Summary

Modifier and Type	Method and Description
void	beforeCancel(ExternalSystemTaskId id) Notifies that task with the given id is queued for the cancellation.
void	onCancel(ExternalSystemTaskId id) Notifies that task with the given id is cancelled.
void	onEnd(ExternalSystemTaskId id) Notifies that task with the given id is finished.
void	onFailure(ExternalSystemTaskId id, java.lang.Exception e) Notifies that task with the given id is failed.
void	onStart(ExternalSystemTaskId id) Deprecated. use onStart(ExternalSystemTaskId, String)
default void	onStart(ExternalSystemTaskId id, java.lang.String workingDir) Notifies that task with the given id is about to be started.
void	onStatusChange(ExternalSystemTaskNotificationEvent event) Notifies about processing state change of task with the given id.
void	onSuccess(ExternalSystemTaskId id) Notifies that task with the given id is finished successfully.
void	onTaskOutput(ExternalSystemTaskId id, java.lang.String text, boolean stdOut) Notifies about text written to stdout/stderr during the task execution

Field Detail

EP_NAME

static final ExtensionPointName<ExternalSystemTaskNotificationListener> EP_NAME

Method Detail

onStart

default void onStart(ExternalSystemTaskId id,
                     java.lang.String workingDir)

Notifies that task with the given id is about to be started.

Parameters:

id - target task's id

workingDir - working directory

onStart

@Deprecated
void onStart(ExternalSystemTaskId id)

Deprecated. use onStart(ExternalSystemTaskId, String)

onStatusChange

void onStatusChange(ExternalSystemTaskNotificationEvent event)

Notifies about processing state change of task with the given id.

Parameters:

event - event that holds information about processing change state of the target task

onTaskOutput

void onTaskOutput(ExternalSystemTaskId id,
                  java.lang.String text,
                  boolean stdOut)

Notifies about text written to stdout/stderr during the task execution

Parameters:

id - id of the task being executed

text - text produced by external system during the target task execution

stdOut - flag which identifies output type (stdout or stderr)

onEnd

void onEnd(ExternalSystemTaskId id)

Notifies that task with the given id is finished.

Parameters:

id - target task's id

onSuccess

void onSuccess(ExternalSystemTaskId id)

Notifies that task with the given id is finished successfully.

Parameters:

id - target task's id

onFailure

void onFailure(ExternalSystemTaskId id,
               java.lang.Exception e)

Notifies that task with the given id is failed.

Parameters:

id - target task's id

e - failure exception

beforeCancel

void beforeCancel(ExternalSystemTaskId id)

Notifies that task with the given id is queued for the cancellation.

'Queued' here means that intellij process-local codebase receives request to cancel the target task and even has not been sent it to the slave gradle api process.

Parameters:

id - target task's id

onCancel

void onCancel(ExternalSystemTaskId id)

Notifies that task with the given id is cancelled.

Parameters:

id - target task's id