Package com.oorian.messaging.events.server

Class TimerEvent

java.lang.Object

com.oorian.messaging.events.server.TimerEvent

public class TimerEvent
extends Object

Event fired by an OorianTimer on each tick.

TimerEvent carries the timer that fired and the cumulative tick count, allowing listeners to identify the source timer and track how many times it has fired.

This event is not part of the element event hierarchy — it is dispatched directly to the registered TimerListener by the timer's executor thread.

Since:

2.1

Version:

1.0

Author:

Marvin P. Warble Jr.

See Also:

• OorianTimer
• TimerListener

Constructor Summary

Constructors

Constructor	Description
TimerEvent(OorianTimer timer, int tickCount)	Creates a new TimerEvent.

Method Summary

Modifier and Type	Method	Description
int	getTickCount()	Returns the cumulative number of times the timer has fired.
OorianTimer	getTimer()	Returns the timer that fired this event.

Methods inherited from class java.lang.Object

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

Constructor Details

TimerEvent

public TimerEvent(OorianTimer timer,
 int tickCount)

Creates a new TimerEvent.

Parameters:

timer - the timer that fired this event

tickCount - the number of times the timer has fired

Method Details

getTimer

public OorianTimer getTimer()

Returns the timer that fired this event.

Returns:

the source timer

getTickCount

public int getTickCount()

Returns the cumulative number of times the timer has fired.

Returns:

the tick count