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

Interface ExternalSystemTask

All Known Implementing Classes:

AbstractExternalSystemTask, ExternalSystemExecuteTaskTask, ExternalSystemResolveProjectTask

public interface ExternalSystemTask

Method Summary

Modifier and Type	Method and Description
boolean	cancel(ExternalSystemTaskNotificationListener... listeners) Initiates cancel request.
boolean	cancel(ProgressIndicator indicator, ExternalSystemTaskNotificationListener... listeners) Initiates cancel request of the current task and updates given indicator's status during that.
void	execute(ExternalSystemTaskNotificationListener... listeners) Executes current task at the calling thread, i.e.
void	execute(ProgressIndicator indicator, ExternalSystemTaskNotificationListener... listeners) Executes current task and updates given indicator's status during that.
java.lang.Throwable	getError()
ExternalSystemTaskId	getId()
ExternalSystemTaskState	getState()
void	refreshState() Forces current task to refresh its state.

Method Detail

getId

ExternalSystemTaskId getId()

getState

ExternalSystemTaskState getState()

getError

java.lang.Throwable getError()

Returns:

error occurred during the task execution (if any)

execute

void execute(ProgressIndicator indicator,
             ExternalSystemTaskNotificationListener... listeners)

Executes current task and updates given indicator's status during that.

Parameters:

indicator - target progress indicator

listeners - callbacks to be notified on task execution update

execute

void execute(ExternalSystemTaskNotificationListener... listeners)

Executes current task at the calling thread, i.e. the call to this method blocks.

Parameters:

listeners - callbacks to be notified about the task execution update

cancel

boolean cancel(ProgressIndicator indicator,
               ExternalSystemTaskNotificationListener... listeners)

Initiates cancel request of the current task and updates given indicator's status during that.

Parameters:

indicator - target progress indicator

listeners - callbacks to be notified on task execution update

cancel

boolean cancel(ExternalSystemTaskNotificationListener... listeners)

Initiates cancel request.

Parameters:

listeners - callbacks to be notified about the task execution update

refreshState

void refreshState()

Forces current task to refresh its state.