com.tplan.robot.util

Class SimpleTimer

java.lang.Object

com.tplan.robot.util.SimpleTimer

All Implemented Interfaces:

Timer, Runnable

public class SimpleTimer
extends Object
implements Runnable, Timer

A simple thread based timer intended to replace javax.swing.Timer usages. Introduced in v3.0.1 to address deadlocks on the timer queue.

Since:

3.0.1

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
SimpleTimer(ActionListener listener, String name, int delay, boolean daemon, boolean fixedIntervals) Construct a repeating timer.

Method Summary

Modifier and Type	Method and Description
boolean	fireAction(ActionEvent e)
int	getDelay() Get the timer delay.
int	getInitialDelay() Get the initial delay.
boolean	isRunning() Find out if the timer is running.
void	run()
void	setActionListener(ActionListener listener) Set the action listener.
void	setInitialDelay(int initialDelay) Set the initial timer delay.
void	setRepeats(boolean repeats) Specify whether the timer should repeatedly call the listener at the specified intervals or run just once and finish.
void	start() Start the timer.
void	stop() Stop the timer.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTimer

public SimpleTimer(ActionListener listener,
                   String name,
                   int delay,
                   boolean daemon,
                   boolean fixedIntervals)

Construct a repeating timer.

Parameters:

listener - an action listener to be called at the scheduled time intervals.

name - name for the timer thread (see Thread.getName())..

delay - the timer delay in milliseconds.

daemon - true will run the timer thread as a daemon.

fixedIntervals - the value of true will deduct the time spent in actionPerformed() from the sleep time. This makes the timer wake up precisely at the scheduled intervals. The value of false will make the timer sleep the full delay after the actionPerformed() method is completed to make sure that the specified delay gets elapsed between each two subsequent actionPerformed() calls.

Method Detail

stop

public void stop()

Stop the timer.

Specified by:

stop in interface Timer

isRunning

public boolean isRunning()

Find out if the timer is running.

Specified by:

isRunning in interface Timer

Returns:

true if the timer is running or false otherwise.

start

public void start()

Start the timer.

Specified by:

start in interface Timer

run

public void run()

Specified by:

run in interface Runnable

fireAction

public boolean fireAction(ActionEvent e)

getInitialDelay

public int getInitialDelay()

Get the initial delay.

Specified by:

getInitialDelay in interface Timer

Returns:

the initial timer delay.

setInitialDelay

public void setInitialDelay(int initialDelay)

Set the initial timer delay. To default to the standard constructor defined delay set the initial delay to a value lower than 0.

Specified by:

setInitialDelay in interface Timer

Parameters:

initialDelay - the initial timer delay in milliseconds.

setRepeats

public void setRepeats(boolean repeats)

Specify whether the timer should repeatedly call the listener at the specified intervals or run just once and finish.

Specified by:

setRepeats in interface Timer

Parameters:

repeats - true repeats, false runs just once.

setActionListener

public void setActionListener(ActionListener listener)

Set the action listener.

Parameters:

listener - the new action listener.

Since:

4.0

getDelay

public int getDelay()

Get the timer delay.

Returns:

the timer delay in milliseconds as passed in the constructor.

Since:

6.1