Package com.intellij.openapi.externalSystem.service.internal

Class ExternalSystemProcessingManager

java.lang.Object

com.intellij.openapi.externalSystem.service.internal.ExternalSystemProcessingManager

All Implemented Interfaces:

Disposable, ExternalSystemTaskNotificationListener

public final class ExternalSystemProcessingManager
extends java.lang.Object
implements ExternalSystemTaskNotificationListener, Disposable

Provides external system tasks monitoring and management facilities.

Thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from interface com.intellij.openapi.externalSystem.model.task.ExternalSystemTaskNotificationListener

EP_NAME

Constructor Summary

Constructors

Constructor and Description
ExternalSystemProcessingManager()

Method Summary

Modifier and Type	Method and Description
void	add(ExternalSystemTask task)
void	beforeCancel(ExternalSystemTaskId id) Notifies that task with the given id is queued for the cancellation.
void	dispose() Usually not invoked directly, see class javadoc.
ExternalSystemTask	findTask(ExternalSystemTaskType type, ProjectSystemId projectSystemId, java.lang.String externalProjectPath)
java.util.List<ExternalSystemTask>	findTasksOfState(ProjectSystemId projectSystemId, ExternalSystemTaskState... taskStates)
boolean	hasTaskOfTypeInProgress(ExternalSystemTaskType type, Project project) Allows to check if any task of the given type is being executed at the moment.
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)
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
void	release(ExternalSystemTaskId id)
void	update()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalSystemProcessingManager

public ExternalSystemProcessingManager()

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

hasTaskOfTypeInProgress

public boolean hasTaskOfTypeInProgress(ExternalSystemTaskType type,
                                       Project project)

Allows to check if any task of the given type is being executed at the moment.

Parameters:

type - target task type

Returns:

true if any task of the given type is being executed at the moment; false otherwise

findTask

public ExternalSystemTask findTask(ExternalSystemTaskType type,
                                   ProjectSystemId projectSystemId,
                                   java.lang.String externalProjectPath)

findTasksOfState

public java.util.List<ExternalSystemTask> findTasksOfState(ProjectSystemId projectSystemId,
                                                           ExternalSystemTaskState... taskStates)

add

public void add(ExternalSystemTask task)

release

public void release(ExternalSystemTaskId id)

onStart

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

Description copied from interface: ExternalSystemTaskNotificationListener

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

Specified by:

onStart in interface ExternalSystemTaskNotificationListener

Parameters:

id - target task's id

workingDir - working directory

onStart

public void onStart(ExternalSystemTaskId id)

Specified by:

onStart in interface ExternalSystemTaskNotificationListener

onStatusChange

public void onStatusChange(ExternalSystemTaskNotificationEvent event)

Description copied from interface: ExternalSystemTaskNotificationListener

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

Specified by:

onStatusChange in interface ExternalSystemTaskNotificationListener

Parameters:

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

onTaskOutput

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

Description copied from interface: ExternalSystemTaskNotificationListener

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

Specified by:

onTaskOutput in interface ExternalSystemTaskNotificationListener

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

public void onEnd(ExternalSystemTaskId id)

Description copied from interface: ExternalSystemTaskNotificationListener

Notifies that task with the given id is finished.

Specified by:

onEnd in interface ExternalSystemTaskNotificationListener

Parameters:

id - target task's id

onSuccess

public void onSuccess(ExternalSystemTaskId id)

Description copied from interface: ExternalSystemTaskNotificationListener

Notifies that task with the given id is finished successfully.

Specified by:

onSuccess in interface ExternalSystemTaskNotificationListener

Parameters:

id - target task's id

onFailure

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

Description copied from interface: ExternalSystemTaskNotificationListener

Notifies that task with the given id is failed.

Specified by:

onFailure in interface ExternalSystemTaskNotificationListener

Parameters:

id - target task's id

e - failure exception

beforeCancel

public void beforeCancel(ExternalSystemTaskId id)

Description copied from interface: ExternalSystemTaskNotificationListener

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.

Specified by:

beforeCancel in interface ExternalSystemTaskNotificationListener

Parameters:

id - target task's id

onCancel

public void onCancel(ExternalSystemTaskId id)

Description copied from interface: ExternalSystemTaskNotificationListener

Notifies that task with the given id is cancelled.

Specified by:

onCancel in interface ExternalSystemTaskNotificationListener

Parameters:

id - target task's id

update

public void update()