Package com.intellij.codeInsight.daemon.impl

Class DaemonProgressIndicator

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.progress.util.AbstractProgressIndicatorBase

com.intellij.codeInsight.daemon.impl.DaemonProgressIndicator

All Implemented Interfaces:

Disposable, ProgressIndicator, StandardProgressIndicator, UserDataHolder, UserDataHolderEx

public class DaemonProgressIndicator
extends AbstractProgressIndicatorBase
implements StandardProgressIndicator, Disposable

Nested Class Summary

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

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
DaemonProgressIndicator()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the current process.
void	cancel(java.lang.Throwable cause)
void	checkCanceled() Usually invoked in the thread associated with this indicator, used to check if the computation performed by this thread has been canceled, and, if yes, stop it immediately (by throwing an exception).
void	dispose() Usually not invoked directly, see class javadoc.
boolean	equals(java.lang.Object obj)
protected java.lang.Throwable	getCancellationTrace()
int	hashCode()
boolean	isCanceled()
static void	setDebug(boolean debug)
void	start() Marks the process as started.
void	stop() Marks the process as finished.
void	stopIfRunning()
java.lang.String	toString()

Methods inherited from class com.intellij.openapi.progress.util.AbstractProgressIndicatorBase

dontStartActivity, finishNonCancelableSection, getFraction, getLock, getModalityState, getText, getText2, initStateFrom, isCancelable, isIndeterminate, isModal, isPopupWasShown, isReuseable, isRunning, isShowing, popState, pushState, setFraction, setIndeterminate, setModalityProgress, setText, setText2, startNonCancelableSection

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

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

finishNonCancelableSection, getFraction, getModalityState, getText, getText2, isIndeterminate, isModal, isPopupWasShown, isRunning, isShowing, popState, pushState, setFraction, setIndeterminate, setModalityProgress, setText, setText2, startNonCancelableSection

Constructor Detail

DaemonProgressIndicator

public DaemonProgressIndicator()

Method Detail

stop

public final void stop()

Description copied from interface: ProgressIndicator

Marks the process as finished. Invoked by ProgressManager internals, shouldn't be called from client code unless you know what you're doing.

Specified by:

stop in interface ProgressIndicator

Overrides:

stop in class AbstractProgressIndicatorBase

stopIfRunning

public void stopIfRunning()

cancel

public final void cancel()

Description copied from interface: ProgressIndicator

Cancels the current process. Is usually invoked not by the process itself, but by some external activity: e.g. a handler for a "Cancel" button pressed by the user (for visible processes), or by some other event handler which recognizes that the process makes no sense.

Specified by:

cancel in interface ProgressIndicator

Overrides:

cancel in class AbstractProgressIndicatorBase

cancel

public final void cancel(java.lang.Throwable cause)

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isCanceled

public final boolean isCanceled()

Specified by:

isCanceled in interface ProgressIndicator

Overrides:

isCanceled in class AbstractProgressIndicatorBase

Returns:

whether the process has been canceled. Usually ProgressIndicator.checkCanceled() is called instead.

See Also:

ProgressIndicator.cancel()

checkCanceled

public final void checkCanceled()

Description copied from interface: ProgressIndicator

Usually invoked in the thread associated with this indicator, used to check if the computation performed by this thread has been canceled, and, if yes, stop it immediately (by throwing an exception). Threads should call this frequently to allow for prompt cancellation. Failure to do this can cause UI freezes.

You might also want to use ProgressManager.checkCanceled() where you don't need to know current indicator and pass it around.

Specified by:

checkCanceled in interface ProgressIndicator

Overrides:

checkCanceled in class AbstractProgressIndicatorBase

getCancellationTrace

protected java.lang.Throwable getCancellationTrace()

Overrides:

getCancellationTrace in class AbstractProgressIndicatorBase

start

public final void start()

Description copied from interface: ProgressIndicator

Marks the process as started. Invoked by ProgressManager internals, shouldn't be called from client code unless you know what you're doing.

Specified by:

start in interface ProgressIndicator

Overrides:

start in class AbstractProgressIndicatorBase

setDebug

public static void setDebug(boolean debug)

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class AbstractProgressIndicatorBase