Package com.intellij.openapi.progress.impl

Class ProgressRunner<R,P extends ProgressIndicator>

java.lang.Object

com.intellij.openapi.progress.impl.ProgressRunner<R,P>

Type Parameters:

R - type of result to be computed by a given task

P - type of progress indicator (to be) associated with a given task

public class ProgressRunner<R,P extends ProgressIndicator>
extends java.lang.Object

A builder-like API for running tasks with ProgressIndicator.

Main goals of this implementation is to:

• Provide a unified way of running tasks under different conditions
• Remove dependence on the calling thread for API usage
• Streamline extensibility
• Encourage asynchronous usage

Usage

Create a new ProgressRunner object with a constructor, providing it with a task to execute. Specify execution thread and progress indicator via respective calls withProgress(P1) and onThread(com.intellij.openapi.progress.impl.ProgressRunner.ThreadToUse), respectively. Submit task and retrieve result as a CompletableFuture via submit() or synchronously as data via submitAndGet()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressRunner.ThreadToUse

Constructor Summary

Constructors

Constructor and Description
ProgressRunner(java.util.function.Function<? super ProgressIndicator,R> computation) Creates new ProgressRunner builder instance dedicated to calculating computation.
ProgressRunner(java.lang.Runnable computation) Creates new ProgressRunner builder instance dedicated to calculating computation.
ProgressRunner(Task task) Creates new ProgressRunner builder instance dedicated to calculating task.

Method Summary

Modifier and Type	Method and Description
static boolean	isCanceled(java.util.concurrent.Future<? extends ProgressIndicator> progressFuture)
ProgressRunner<R,P>	modal()
ProgressRunner<R,P>	onThread(ProgressRunner.ThreadToUse thread) Specifies thread which should execute computation.
java.util.concurrent.CompletableFuture<ProgressResult<R>>	submit() Executes computation with the previously specified environment asynchronously, or synchronously if sync() was called previously.
ProgressResult<R>	submitAndGet() Executes computation with the previously specified environment synchronously.
ProgressRunner<R,P>	sync()
static java.lang.Throwable	unwrap(java.lang.Throwable exception)
<P1 extends ProgressIndicator> ProgressRunner<R,P1>	withProgress(java.util.concurrent.CompletableFuture<P1> progressIndicatorFuture) Specifies an asynchronous computation which will be used to obtain progress indicator to be associated with computation under progress.
<P1 extends ProgressIndicator> ProgressRunner<R,P1>	withProgress(P1 progressIndicator) Specifies a progress indicator to be associated with computation under progress.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressRunner

public ProgressRunner(java.lang.Runnable computation)

Creates new ProgressRunner builder instance dedicated to calculating computation. Does not start computation.

Parameters:

computation - runnable to be executed under progress

ProgressRunner

public ProgressRunner(Task task)

Creates new ProgressRunner builder instance dedicated to calculating task. Does not start computation.

Parameters:

task - task to be executed under progress

ProgressRunner

public ProgressRunner(java.util.function.Function<? super ProgressIndicator,R> computation)

Creates new ProgressRunner builder instance dedicated to calculating computation. Does not start computation.

Parameters:

computation - runnable to be executed under progress

Method Detail

sync

public ProgressRunner<R,P> sync()

modal

public ProgressRunner<R,P> modal()

onThread

public ProgressRunner<R,P> onThread(ProgressRunner.ThreadToUse thread)

Specifies thread which should execute computation. Possible values: ProgressRunner.ThreadToUse.POOLED and ProgressRunner.ThreadToUse.WRITE.

Parameters:

thread - thread to execute computation

withProgress

public <P1 extends ProgressIndicator> ProgressRunner<R,P1> withProgress(P1 progressIndicator)

Specifies a progress indicator to be associated with computation under progress.

Parameters:

progressIndicator - progress indicator instance

withProgress

public <P1 extends ProgressIndicator> ProgressRunner<R,P1> withProgress(java.util.concurrent.CompletableFuture<P1> progressIndicatorFuture)

Specifies an asynchronous computation which will be used to obtain progress indicator to be associated with computation under progress.

Parameters:

progressIndicatorFuture - future with progress indicator

submitAndGet

public ProgressResult<R> submitAndGet()

Executes computation with the previously specified environment synchronously.

Returns:

a ProgressResult data class representing the result of computation

submit

public java.util.concurrent.CompletableFuture<ProgressResult<R>> submit()

Executes computation with the previously specified environment asynchronously, or synchronously if sync() was called previously.

Returns:

a completable future representing the computation via ProgressResult data class

isCanceled

public static boolean isCanceled(java.util.concurrent.Future<? extends ProgressIndicator> progressFuture)

unwrap

public static java.lang.Throwable unwrap(java.lang.Throwable exception)