Package xal.tools.dispatch

Class DispatchTimer

java.lang.Object

xal.tools.dispatch.DispatchTimer

public class DispatchTimer
extends Object

DispatchTimer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DispatchTimer.DispatchTimerMode	possible dispatch modes

Constructor Summary

Constructors

Constructor	Description
DispatchTimer(DispatchQueue eventQueue, Runnable eventHandler)	Constructor
DispatchTimer(DispatchTimer.DispatchTimerMode dispatchMode, DispatchQueue eventQueue, Runnable eventHandler)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel this timer
void	dispose()	dispose of this timer's resources
protected void	finalize()	release resources held by this timer
static DispatchTimer	getCoalescingInstance(DispatchQueue eventQueue, Runnable eventHandler)	Create a new coalescing timer
static DispatchTimer	getFixedRateInstance(DispatchQueue eventQueue, Runnable eventHandler)	Create a new fixed rate timer
boolean	isDisposed()	determine whether this timer has been disposed
boolean	isSuspended()	Determines whether this queue is suspended (disposed implies suspended)
void	resume()	resume this timer
void	setCancelHandler(Runnable cancelHandler)	Set the cancel handler which is dispatched to the queue when the timer is canceled
void	setEventHandler(Runnable eventHandler)	Set the event handler which is dispatched to the queue when the timer fires
void	setStartTimeAndInterval(Date startTime, long milliInterval, int nanoInterval)	Set the time at which this timer starts and the interval between when the timer fires.
void	startNowWithInterval(long milliInterval, int nanoInterval)	Start the timer now and set the interval between when the timer fires.
void	suspend()	suspend this timer if it is processing (do nothing if disposed or already suspended)

Methods inherited from class java.lang.Object

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

Constructor Details

DispatchTimer

public DispatchTimer(DispatchTimer.DispatchTimerMode dispatchMode,
 DispatchQueue eventQueue,
 Runnable eventHandler)

Primary Constructor

DispatchTimer

public DispatchTimer(DispatchQueue eventQueue,
 Runnable eventHandler)

Constructor

Method Details

getFixedRateInstance

public static DispatchTimer getFixedRateInstance(DispatchQueue eventQueue,
 Runnable eventHandler)

Create a new fixed rate timer

getCoalescingInstance

public static DispatchTimer getCoalescingInstance(DispatchQueue eventQueue,
 Runnable eventHandler)

Create a new coalescing timer

finalize

protected void finalize()
                 throws Throwable

release resources held by this timer

Overrides:

finalize in class Object

Throws:

Throwable

setEventHandler

public void setEventHandler(Runnable eventHandler)

Set the event handler which is dispatched to the queue when the timer fires

setCancelHandler

public void setCancelHandler(Runnable cancelHandler)

Set the cancel handler which is dispatched to the queue when the timer is canceled

startNowWithInterval

public void startNowWithInterval(long milliInterval,
 int nanoInterval)

Start the timer now and set the interval between when the timer fires.

Parameters:

milliInterval - milliseconds of the interval between when the timer fires

nanoInterval - nanoseconds of the interval between when the timer fires

setStartTimeAndInterval

public void setStartTimeAndInterval(Date startTime,
 long milliInterval,
 int nanoInterval)

Set the time at which this timer starts and the interval between when the timer fires.

Parameters:

milliInterval - milliseconds of the interval between when the timer fires

nanoInterval - nanoseconds of the interval between when the timer fires

cancel

public void cancel()

Cancel this timer

isSuspended

public boolean isSuspended()

Determines whether this queue is suspended (disposed implies suspended)

suspend

public void suspend()

suspend this timer if it is processing (do nothing if disposed or already suspended)

resume

public void resume()

resume this timer

dispose

public void dispose()

dispose of this timer's resources

isDisposed

public boolean isDisposed()

determine whether this timer has been disposed