Package com.intellij.openapi.progress.impl

Class ProgressSuspender

java.lang.Object

com.intellij.openapi.progress.impl.ProgressSuspender

All Implemented Interfaces:

java.lang.AutoCloseable

public class ProgressSuspender
extends java.lang.Object
implements java.lang.AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProgressSuspender.SuspenderListener

Field Summary

Fields

Modifier and Type	Field and Description
static Topic<ProgressSuspender.SuspenderListener>	TOPIC

Method Summary

Modifier and Type	Method and Description
void	attachToProgress(ProgressIndicatorEx progress) Associates an additional progress indicator with this suspender, so that its #checkCanceled can later block the calling thread.
void	close()
java.lang.String	getSuspendedText()
static ProgressSuspender	getSuspender(ProgressIndicator indicator)
boolean	isSuspended()
static ProgressSuspender	markSuspendable(ProgressIndicator indicator, java.lang.String suspendedText)
void	resumeProcess()
void	suspendProcess(java.lang.String reason)

Methods inherited from class java.lang.Object

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

Field Detail

TOPIC

public static final Topic<ProgressSuspender.SuspenderListener> TOPIC

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

markSuspendable

public static ProgressSuspender markSuspendable(ProgressIndicator indicator,
                                                java.lang.String suspendedText)

getSuspender

public static ProgressSuspender getSuspender(ProgressIndicator indicator)

attachToProgress

public void attachToProgress(ProgressIndicatorEx progress)

Associates an additional progress indicator with this suspender, so that its #checkCanceled can later block the calling thread.

getSuspendedText

public java.lang.String getSuspendedText()

isSuspended

public boolean isSuspended()

suspendProcess

public void suspendProcess(java.lang.String reason)

Parameters:

reason - if provided, is displayed in the UI instead of suspended text passed into constructor until the progress is resumed

resumeProcess

public void resumeProcess()