org.zoolu.util

Class Timer

java.lang.Object

org.zoolu.util.Timer

public class Timer
extends java.lang.Object

A Timer is a simple object that fires the TimerListener.onTimeout(Timer) method when the time expires. Timer has to be explicitly started, and can be halted before it expires.

A timer may run is 'daemon' mode or 'non-daemon' mode.
In 'daemon' mode, if all program threads terminate, the timer terminates silently, without firing the corresponding timeout callback.
Conversely, in 'non-daemon' mode, the program terminates only when the timer expires (or it is explicitly halted).

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DAEMON_MODE Whether the default mode is 'daemon', or not
protected boolean	is_running Whether this timer is running
protected TimerListener	listener Timer listener
protected long	time Timeout value

Constructor Summary

Constructors

Constructor and Description
Timer(long time, TimerListener listener) Creates a new Timer.

Method Summary

Modifier and Type	Method and Description
long	getExpirationTime() Gets the remaining time.
long	getTime() Gets the initial time.
void	halt() Stops the Timer.
boolean	isRunning() Whether the timer is running.
void	start() Starts the timer.
void	start(boolean daemon_mode) Starts the timer.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DAEMON_MODE

public static boolean DEFAULT_DAEMON_MODE

Whether the default mode is 'daemon', or not

time

protected long time

Timeout value

is_running

protected boolean is_running

Whether this timer is running

listener

protected TimerListener listener

Timer listener

Constructor Detail

Timer

public Timer(long time,
             TimerListener listener)

Creates a new Timer.

The Timer is not automatically started. You need to call the start() method.

Parameters:

time - the timer expiration time in milliseconds

listener - timer listener

Method Detail

getTime

public long getTime()

Gets the initial time.

Returns:

the initial time in milliseconds

getExpirationTime

public long getExpirationTime()

Gets the remaining time.

Returns:

the remaining time in milliseconds

start

public void start()

Starts the timer.

start

public void start(boolean daemon_mode)

Starts the timer.

Parameters:

daemon_mode - whether running in 'daemon' mode In 'daemon' mode, when all other threads terminate, the program also ends regardless the timer was still running, and no timeout callback is fired. In 'non-daemon' mode, the program ends only when all active timers have expired or explicitly halted.

isRunning

public boolean isRunning()

Whether the timer is running.

Returns:

true if it is running

halt

public void halt()

Stops the Timer. The method TimerListener.onTimeout(Timer) of the timer listener will not be fired.