Package com.intellij.util

Class Alarm

java.lang.Object

com.intellij.util.Alarm

All Implemented Interfaces:

Disposable

public class Alarm
extends Object
implements Disposable

Allows to schedule Runnable instances (requests) to be executed after a specific time interval on a specific thread. Use addRequest(java.lang.Runnable, int, boolean) methods to schedule the requests. Two requests scheduled with the same delay are executed sequentially, one after the other. cancelAllRequests() and cancelRequest(Runnable) allow to cancel already scheduled requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Alarm.ThreadToUse

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

Disposable.Parent

Constructor Summary

Constructors

Constructor	Description
Alarm()	Creates alarm that works in Swing thread
Alarm(Disposable parentDisposable)
Alarm(Alarm.ThreadToUse threadToUse)
Alarm(Alarm.ThreadToUse threadToUse, Disposable parentDisposable)

Method Summary

Modifier and Type	Method	Description
void	addRequest(Runnable request, int delay, boolean runWithActiveFrameOnly)
void	addRequest(Runnable request, long delayMillis)
int	cancelAllRequests()
boolean	cancelRequest(Runnable request)
void	dispose()
void	flush()
int	getActiveRequestCount()
boolean	isDisposed()
protected boolean	isEdt()
boolean	isEmpty()
static boolean	isEventDispatchThread()

Methods inherited from class java.lang.Object

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

Constructor Details

Alarm

public Alarm()

Creates alarm that works in Swing thread

Alarm

public Alarm(@NotNull
 Disposable parentDisposable)

Alarm

public Alarm(@NotNull
 Alarm.ThreadToUse threadToUse)

Alarm

public Alarm(@NotNull
 Alarm.ThreadToUse threadToUse,
 @Nullable
 Disposable parentDisposable)

Method Details

dispose

public void dispose()

Specified by:

dispose in interface Disposable

addRequest

public void addRequest(@NotNull
 Runnable request,
 int delay,
 boolean runWithActiveFrameOnly)

addRequest

public void addRequest(@NotNull
 Runnable request,
 long delayMillis)

cancelRequest

public boolean cancelRequest(@NotNull
 Runnable request)

cancelAllRequests

public int cancelAllRequests()

flush

@TestOnly
public void flush()

getActiveRequestCount

public int getActiveRequestCount()

isEmpty

public boolean isEmpty()

isEdt

protected boolean isEdt()

isEventDispatchThread

public static boolean isEventDispatchThread()

isDisposed

public boolean isDisposed()