Package com.intellij.openapi.progress

Class Task

java.lang.Object

com.intellij.openapi.progress.Task

All Implemented Interfaces:

Progressive, TaskInfo

Direct Known Subclasses:

Task.Backgroundable, Task.Modal

public abstract class Task
extends java.lang.Object
implements TaskInfo, Progressive

Intended to run tasks, both modal and non-modal (backgroundable) Example of use:

 new Task.Backgroundable(project, "Synchronizing data", true) {
  public void run(ProgressIndicator indicator) {
    indicator.setText("Loading changes");
    indicator.setIndeterminate(false);
    indicator.setFraction(0.0);
    // some code
    indicator.setFraction(1.0);
  }
 }.setCancelText("Stop loading").queue();
 

See Also:

ProgressManager.run(Task)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.Backgroundable
static class	Task.ConditionalModal
static class	Task.Modal
static class	Task.NotificationInfo
static class	Task.WithResult<T,E extends java.lang.Exception>

Field Summary

Fields

Modifier and Type	Field and Description
protected Project	myProject
protected java.lang.String	myTitle

Method Summary

Modifier and Type	Method and Description
Task.Backgroundable	asBackgroundable()
Task.Modal	asModal()
java.lang.String	getCancelText()
java.lang.String	getCancelTooltipText()
Task.NotificationInfo	getNotificationInfo()
Project	getProject()
java.lang.String	getTitle()
boolean	isCancellable()
boolean	isHeadless()
abstract boolean	isModal()
Task.NotificationInfo	notifyFinished()
void	onCancel() This callback will be invoked on AWT dispatch thread.
void	onError(java.lang.Exception error) Deprecated. use onThrowable(Throwable) instead
void	onFinished() This callback will be invoked on AWT dispatch thread, after other specific handlers.
void	onSuccess() This callback will be invoked on AWT dispatch thread.
void	onThrowable(java.lang.Throwable error) This callback will be invoked on AWT dispatch thread.
void	queue()
Task	setCancelText(java.lang.String cancelText)
Task	setCancelTooltipText(java.lang.String cancelTooltipText)
Task	setTitle(java.lang.String title)
EdtReplacementThread	whereToRunCallbacks() Specifies the thread to run callbacks on.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.progress.Progressive

run

Field Detail

myProject

protected final Project myProject

myTitle

protected java.lang.String myTitle

Method Detail

onCancel

public void onCancel()

This callback will be invoked on AWT dispatch thread. Callback executed when run() throws ProcessCanceledException or if its ProgressIndicator was canceled.

onSuccess

public void onSuccess()

This callback will be invoked on AWT dispatch thread.

onError

@Deprecated
public void onError(java.lang.Exception error)

Deprecated. use onThrowable(Throwable) instead

This callback will be invoked on AWT dispatch thread.

Callback executed when Progressive.run(ProgressIndicator) throws an exception (except ProcessCanceledException).

onThrowable

public void onThrowable(java.lang.Throwable error)

This callback will be invoked on AWT dispatch thread.

Callback executed when Progressive.run(ProgressIndicator) throws an exception (except ProcessCanceledException).

onFinished

public void onFinished()

This callback will be invoked on AWT dispatch thread, after other specific handlers.

whereToRunCallbacks

public EdtReplacementThread whereToRunCallbacks()

Specifies the thread to run callbacks on. See EdtReplacementThread documentation for more info.

getProject

public final Project getProject()

queue

public final void queue()

getTitle

public final java.lang.String getTitle()

Specified by:

getTitle in interface TaskInfo

setTitle

public final Task setTitle(java.lang.String title)

getCancelText

public final java.lang.String getCancelText()

Specified by:

getCancelText in interface TaskInfo

setCancelText

public final Task setCancelText(java.lang.String cancelText)

getNotificationInfo

public Task.NotificationInfo getNotificationInfo()

notifyFinished

public Task.NotificationInfo notifyFinished()

isHeadless

public boolean isHeadless()

setCancelTooltipText

public final Task setCancelTooltipText(java.lang.String cancelTooltipText)

getCancelTooltipText

public final java.lang.String getCancelTooltipText()

Specified by:

getCancelTooltipText in interface TaskInfo

isCancellable

public final boolean isCancellable()

Specified by:

isCancellable in interface TaskInfo

isModal

public abstract boolean isModal()

asModal

public final Task.Modal asModal()

asBackgroundable

public final Task.Backgroundable asBackgroundable()