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

Class AbstractExternalSystemTask

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.externalSystem.service.internal.AbstractExternalSystemTask

All Implemented Interfaces:

ExternalSystemTask, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

ExternalSystemExecuteTaskTask, ExternalSystemResolveProjectTask

public abstract class AbstractExternalSystemTask
extends UserDataHolderBase
implements ExternalSystemTask

Encapsulates particular task performed by external system integration.

Thread-safe.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExternalSystemTask(ProjectSystemId id, ExternalSystemTaskType type, Project project, java.lang.String externalProjectPath)

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.
protected boolean	compareAndSetState(ExternalSystemTaskState expect, ExternalSystemTaskState update)
protected abstract boolean	doCancel()
protected abstract void	doExecute()
boolean	equals(java.lang.Object o)
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()
java.lang.String	getExternalProjectPath()
ProjectSystemId	getExternalSystemId()
ExternalSystemTaskId	getId()
Project	getIdeProject()
ExternalSystemTaskState	getState()
int	hashCode()
void	refreshState() Forces current task to refresh its state.
protected void	setState(ExternalSystemTaskState state)
java.lang.String	toString()
protected java.lang.String	wrapProgressText(java.lang.String text)
protected static ExternalSystemTaskNotificationListener	wrapWithListener(ExternalSystemProgressNotificationManagerImpl manager)

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractExternalSystemTask

protected AbstractExternalSystemTask(ProjectSystemId id,
                                     ExternalSystemTaskType type,
                                     Project project,
                                     java.lang.String externalProjectPath)

Method Detail

getExternalSystemId

public ProjectSystemId getExternalSystemId()

getId

public ExternalSystemTaskId getId()

Specified by:

getId in interface ExternalSystemTask

getState

public ExternalSystemTaskState getState()

Specified by:

getState in interface ExternalSystemTask

setState

protected void setState(ExternalSystemTaskState state)

compareAndSetState

protected boolean compareAndSetState(ExternalSystemTaskState expect,
                                     ExternalSystemTaskState update)

getError

public java.lang.Throwable getError()

Specified by:

getError in interface ExternalSystemTask

Returns:

error occurred during the task execution (if any)

getIdeProject

public Project getIdeProject()

getExternalProjectPath

public java.lang.String getExternalProjectPath()

refreshState

public void refreshState()

Description copied from interface: ExternalSystemTask

Forces current task to refresh its state.

Specified by:

refreshState in interface ExternalSystemTask

execute

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

Description copied from interface: ExternalSystemTask

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

Specified by:

execute in interface ExternalSystemTask

Parameters:

indicator - target progress indicator

listeners - callbacks to be notified on task execution update

execute

public void execute(ExternalSystemTaskNotificationListener... listeners)

Description copied from interface: ExternalSystemTask

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

Specified by:

execute in interface ExternalSystemTask

Parameters:

listeners - callbacks to be notified about the task execution update

doExecute

protected abstract void doExecute()
                           throws java.lang.Exception

Throws:

java.lang.Exception

cancel

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

Description copied from interface: ExternalSystemTask

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

Specified by:

cancel in interface ExternalSystemTask

Parameters:

indicator - target progress indicator

listeners - callbacks to be notified on task execution update

cancel

public boolean cancel(ExternalSystemTaskNotificationListener... listeners)

Description copied from interface: ExternalSystemTask

Initiates cancel request.

Specified by:

cancel in interface ExternalSystemTask

Parameters:

listeners - callbacks to be notified about the task execution update

doCancel

protected abstract boolean doCancel()
                             throws java.lang.Exception

Throws:

java.lang.Exception

wrapProgressText

protected java.lang.String wrapProgressText(java.lang.String text)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

wrapWithListener

protected static ExternalSystemTaskNotificationListener wrapWithListener(ExternalSystemProgressNotificationManagerImpl manager)