Package com.intellij.util

Class Alarm

java.lang.Object

com.intellij.util.Alarm

All Implemented Interfaces:

Disposable

public class Alarm
extends java.lang.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 and Description
static class	Alarm.ThreadToUse

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	_addRequest(java.lang.Runnable request, long delayMillis, ModalityState modalityState)
void	addComponentRequest(java.lang.Runnable request, int delayMillis)
void	addComponentRequest(java.lang.Runnable request, long delayMillis)
void	addRequest(java.lang.Runnable request, int delayMillis)
void	addRequest(java.lang.Runnable request, int delay, boolean runWithActiveFrameOnly)
void	addRequest(java.lang.Runnable request, int delayMillis, ModalityState modalityState)
void	addRequest(java.lang.Runnable request, long delayMillis)
void	addRequest(java.lang.Runnable request, long delayMillis, ModalityState modalityState)
protected void	cancelAllAndAddRequest(java.lang.Runnable request, int delayMillis, ModalityState modalityState)
int	cancelAllRequests()
boolean	cancelRequest(java.lang.Runnable request)
void	dispose() Usually not invoked directly, see class javadoc.
void	drainRequestsInTest()
int	getActiveRequestCount()
protected java.util.List<java.lang.Runnable>	getUnfinishedRequests()
boolean	isDisposed()
boolean	isEmpty()
Alarm	setActivationComponent(javax.swing.JComponent component)
void	waitForAllExecuted(long timeout, java.util.concurrent.TimeUnit unit) wait for all requests to start execution (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

Alarm

public Alarm()

Creates alarm that works in Swing thread

Alarm

public Alarm(Disposable parentDisposable)

Creates alarm that works in Swing thread

Alarm

public Alarm(Alarm.ThreadToUse threadToUse)

Alarm

public Alarm(Alarm.ThreadToUse threadToUse,
             Disposable parentDisposable)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

addRequest

public void addRequest(java.lang.Runnable request,
                       int delay,
                       boolean runWithActiveFrameOnly)

addRequest

public void addRequest(java.lang.Runnable request,
                       long delayMillis)

addRequest

public void addRequest(java.lang.Runnable request,
                       int delayMillis)

addComponentRequest

public void addComponentRequest(java.lang.Runnable request,
                                int delayMillis)

addComponentRequest

public void addComponentRequest(java.lang.Runnable request,
                                long delayMillis)

addRequest

public void addRequest(java.lang.Runnable request,
                       int delayMillis,
                       ModalityState modalityState)

addRequest

public void addRequest(java.lang.Runnable request,
                       long delayMillis,
                       ModalityState modalityState)

cancelAllAndAddRequest

protected void cancelAllAndAddRequest(java.lang.Runnable request,
                                      int delayMillis,
                                      ModalityState modalityState)

_addRequest

protected void _addRequest(java.lang.Runnable request,
                           long delayMillis,
                           ModalityState modalityState)

cancelRequest

public boolean cancelRequest(java.lang.Runnable request)

cancelAllRequests

public int cancelAllRequests()

drainRequestsInTest

public void drainRequestsInTest()

getUnfinishedRequests

protected java.util.List<java.lang.Runnable> getUnfinishedRequests()

waitForAllExecuted

public void waitForAllExecuted(long timeout,
                               java.util.concurrent.TimeUnit unit)
                        throws java.lang.InterruptedException,
                               java.util.concurrent.ExecutionException,
                               java.util.concurrent.TimeoutException

wait for all requests to start execution (i.e. their delay elapses and their run() method, well, runs) and then wait for the execution to finish.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

getActiveRequestCount

public int getActiveRequestCount()

isEmpty

public boolean isEmpty()

setActivationComponent

public Alarm setActivationComponent(javax.swing.JComponent component)

isDisposed

public boolean isDisposed()