com.alee.utils.swing

Class WebTimer

java.lang.Object

com.alee.utils.swing.WebTimer

All Implemented Interfaces:

Serializable

public class WebTimer
extends Object
implements Serializable

This timer is a small extension for standard javax.swing.Timer. Instead of running in a single queue it creates separate Threads for each timer and does not affect event-dispatching thread, until events are dispatched. This basically means that you can use any number of Timer instances and you can run them altogether without having any issues. Also this Timer implementation offers a variety of additional features and improvements which standard timer doesn't have (for example you can dispatch events in a separate non-EDT thread and as a result avoid using EDT at all where it is not necessary).

Author:

Mikle Garin

See Also:

Timer, TimerActionListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	actionCommand Action command for fired events.
protected boolean	coalesce Whether each action should be fired from a separate invoke and wait call or not.
protected int	cycleCount Number of executed cycles;
protected int	cyclesLimit Timer cycles execution limit.
static int	defaultCyclesLimit Default cycles number limit.
static String	defaultThreadName Default name for timer thread.
protected long	delay Delay between timer cycles in milliseconds.
protected Thread	exec Last timer thread.
protected int	id Unique (within one timer instance) ID of currently running thread.
protected long	initialDelay Delay before the first timer cycle run in milliseconds.
protected int	lastId ID of previously executed thread.
protected EventListenerList	listeners Timer event listeners list.
protected String	name Internal timer thread name.
protected boolean	nonBlockingStop Whether or not timer should use non-blocking stop method behavior.
protected boolean	repeats Whether timer repeat its cycles or not.
protected Map<Integer,Boolean>	running Map of marks for currently active threads.
protected long	sleepStart Last timer cycle start time.
protected long	sleepTime Last timer cycle delay time.
protected boolean	useDaemonThread Whether should use daemon thread instead of user one or not.
static boolean	useEdtByDefault Whether EDT should be used as the default timer action execution thread.
protected boolean	useEventDispatchThread Whether actions should be fired from Event Dispatch Thread or not.

Constructor Summary

Constructors

Constructor and Description
WebTimer(long delay) Constructs timer with specified delay.
WebTimer(long delay, ActionListener listener) Constructs timer with specified delay and action listener.
WebTimer(long delay, long initialDelay) Constructs timer with specified delay and initial delay.
WebTimer(long delay, long initialDelay, ActionListener listener) Constructs timer with specified delay, initial delay and action listener.
WebTimer(String delay) Constructs timer with specified delay.
WebTimer(String delay, ActionListener listener) Constructs timer with specified delay and action listener.
WebTimer(String name, long delay) Constructs timer with specified internal thread name and delay.
WebTimer(String name, long delay, ActionListener listener) Constructs timer with specified internal thread name, delay and action listener.
WebTimer(String name, long delay, long initialDelay) Constructs timer with specified internal thread name, delay and initial delay.
WebTimer(String name, long delay, long initialDelay, ActionListener listener) Constructs timer with specified internal thread name, delay, initial delay and action listener.
WebTimer(String name, String delay) Constructs timer with specified internal thread name and delay.
WebTimer(String name, String delay, ActionListener listener) Constructs timer with specified internal thread name, delay and action listener.
WebTimer(String name, String delay, String initialDelay, ActionListener listener) Constructs timer with specified internal thread name, delay, initial delay and action listener.

Method Summary

Modifier and Type	Method and Description
WebTimer	addActionListener(ActionListener listener) Adds new action listener.
protected void	cleanUp(int id) Cleans thread ID cache.
protected ActionEvent	createActionEvent() Returns action event.
static WebTimer	delay(long delay, ActionListener listener) Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.
static WebTimer	delay(long delay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.
static WebTimer	delay(String delay, ActionListener listener) Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.
static WebTimer	delay(String delay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.
static WebTimer	delay(String name, long delay, ActionListener listener) Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.
static WebTimer	delay(String name, long delay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.
static WebTimer	delay(String name, String delay, ActionListener listener) Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.
static WebTimer	delay(String name, String delay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.
void	fireActionPerformed(int id) Fires action events.
String	getActionCommand() Returns action command for fired events.
int	getCycleCount() Returns executed cycles count.
int	getCycleNumber() Returns current cycle number.
int	getCyclesLimit() Returns timer cycles execution limit.
long	getCycleTimeLeft() Returns time left in milliseconds until current cycle action execution.
long	getCycleTimePassed() Returns time passed in milliseconds since current cycle start.
long	getDelay() Returns delay between timer cycles in milliseconds.
long	getInitialDelay() Returns delay before the first timer cycle run in milliseconds.
String	getInitialStringDelay() Returns delay before the first timer cycle run.
List<ActionListener>	getListeners() Returns available action listeners list.
String	getName() Returns internal timer thread name.
String	getStringDelay() Returns delay between timer cycles.
boolean	isCoalesce() Returns whether each action should be fired from a separate invoke and wait call or not.
boolean	isLastCycle() Return whether last cycle execution is ongoing or not.
boolean	isNonBlockingStop() Returns whether or not timer should use non-blocking stop method behavior.
boolean	isRepeats() Returns whether timer repeat its cycles or not.
boolean	isRunning() Returns whether this WebTimer is running or not.
boolean	isUseDaemonThread() Returns whether should use daemon thread instead of user one or not.
boolean	isUseEventDispatchThread() Returns whether actions should be fired from Event Dispatch Thread or not.
WebTimer	removeActionListener(ActionListener listener) Removes an action listener.
static WebTimer	repeat(boolean useDaemonThread, String name, long delay, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(boolean useDaemonThread, String name, long delay, long initialDelay, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(boolean useDaemonThread, String name, long delay, long initialDelay, int cyclesLimit, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(long delay, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(long delay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(long delay, int cyclesLimit, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(long delay, int cyclesLimit, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(long delay, long initialDelay, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(long delay, long initialDelay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(long delay, long initialDelay, int cyclesLimit, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(long delay, long initialDelay, int cyclesLimit, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(String delay, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String delay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String delay, int cyclesLimit, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String delay, int cyclesLimit, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String name, long delay, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String name, long delay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String name, long delay, int cyclesLimit, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String name, long delay, int cyclesLimit, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String name, long delay, long initialDelay, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(String name, long delay, long initialDelay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(String name, long delay, long initialDelay, int cyclesLimit, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(String name, long delay, long initialDelay, int cyclesLimit, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.
static WebTimer	repeat(String name, String delay, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String name, String delay, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String name, String delay, int cyclesLimit, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
static WebTimer	repeat(String name, String delay, int cyclesLimit, boolean useEventDispatchThread, ActionListener listener) Returns newly created and started timer that repeats and has the specified delay and action listener.
WebTimer	restart() Restarts timer execution.
WebTimer	restart(long delay) Restarts timer execution and modifies timer delay.
WebTimer	restart(long initialDelay, long delay) Restarts timer execution and modifies timer delays.
WebTimer	restart(String delay) Restarts timer execution and modifies timer delay.
WebTimer	restart(String initialDelay, String delay) Restarts timer execution and modifies timer delays.
WebTimer	setActionCommand(String actionCommand) Sets action command for fired events.
protected void	setAlive(int id, boolean alive) Sets whether thread under specified ID is alive or not.
WebTimer	setCoalesce(boolean coalesce) Sets whether each action should be fired from a separate invoke and wait call or not.
WebTimer	setCyclesLimit(int cyclesLimit) Sets timer cycles execution limit.
WebTimer	setDelay(long delay) Sets delay between timer cycles in milliseconds.
WebTimer	setDelay(String delay) Sets delay between timer cycles.
WebTimer	setInitialDelay(long initialDelay) Sets delay before the first timer cycle run in milliseconds.
WebTimer	setInitialDelay(String initialDelay) Sets delay before the first timer cycle run.
WebTimer	setName(String name) Sets internal timer thread name.
WebTimer	setNonBlockingStop(boolean nonBlockingStop) Sets whether or not timer should use non-blocking stop method behavior.
WebTimer	setRepeats(boolean repeats) Sets whether timer should repeat its cycles or not.
WebTimer	setUseDaemonThread(boolean useDaemonThread) Returns whether should use daemon thread instead of user one or not.
WebTimer	setUseEventDispatchThread(boolean useEventDispatchThread) Sets whether actions should be fired from Event Dispatch Thread or not.
protected boolean	shouldContinue(int cycle, int id) Returns whether thread with specified ID should continue execution or not.
WebTimer	start() Starts timer execution.
protected void	startExec() Starts timer execution thread.
WebTimer	stop() Stops timer execution.
protected void	stopExec() Stops timer execution.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

defaultThreadName

public static String defaultThreadName

Default name for timer thread.

defaultCyclesLimit

public static int defaultCyclesLimit

Default cycles number limit.

useEdtByDefault

public static boolean useEdtByDefault

Whether EDT should be used as the default timer action execution thread.

delay

protected long delay

Delay between timer cycles in milliseconds.

initialDelay

protected long initialDelay

Delay before the first timer cycle run in milliseconds.

repeats

protected boolean repeats

Whether timer repeat its cycles or not.

coalesce

protected boolean coalesce

Whether each action should be fired from a separate invoke and wait call or not. This might be useful if you are going to use multiple action listeners and make some interface changes on each action.

useEventDispatchThread

protected boolean useEventDispatchThread

Whether actions should be fired from Event Dispatch Thread or not. This might be useful if operations you want to perform within timer cycles have nothing to do with Event Dispatch Thread.

useDaemonThread

protected boolean useDaemonThread

Whether should use daemon thread instead of user one or not. Daemon thread will allow JVM to shutdown even if timer is still running. This option should be set before starting timer to have any effect.

nonBlockingStop

protected boolean nonBlockingStop

Whether or not timer should use non-blocking stop method behavior. Blocking behavior will join execution thread (and possibly EDT with it). Non-blocking behavior will simply send abort commands and continue without waiting for actual execution to stop.

actionCommand

@NotNull
protected String actionCommand

Action command for fired events.

name

@NotNull
protected String name

Internal timer thread name.

cyclesLimit

protected int cyclesLimit

Timer cycles execution limit. Zero and less = unlimited amount of execution cycles.

listeners

protected final EventListenerList listeners

Timer event listeners list.

id

protected transient int id

Unique (within one timer instance) ID of currently running thread.

lastId

protected transient int lastId

ID of previously executed thread.

running

@NotNull
protected final transient Map<Integer,Boolean> running

Map of marks for currently active threads.

sleepStart

protected transient long sleepStart

Last timer cycle start time.

sleepTime

protected transient long sleepTime

Last timer cycle delay time.

cycleCount

protected transient int cycleCount

Number of executed cycles;

exec

@Nullable
protected transient Thread exec

Last timer thread.

Constructor Detail

WebTimer

public WebTimer(@NotNull
                String delay)

Constructs timer with specified delay.

Parameters:

delay - delay between timer cycles

WebTimer

public WebTimer(long delay)

Constructs timer with specified delay.

Parameters:

delay - delay between timer cycles in milliseconds

WebTimer

public WebTimer(@NotNull
                String name,
                @NotNull
                String delay)

Constructs timer with specified internal thread name and delay.

Parameters:

name - internal thread name

delay - delay between timer cycles

WebTimer

public WebTimer(@NotNull
                String name,
                long delay)

Constructs timer with specified internal thread name and delay.

Parameters:

name - internal thread name

delay - delay between timer cycles in milliseconds

WebTimer

public WebTimer(long delay,
                long initialDelay)

Constructs timer with specified delay and initial delay.

Parameters:

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

WebTimer

public WebTimer(@NotNull
                String name,
                long delay,
                long initialDelay)

Constructs timer with specified internal thread name, delay and initial delay.

Parameters:

name - internal thread name

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

WebTimer

public WebTimer(@NotNull
                String delay,
                @Nullable
                ActionListener listener)

Constructs timer with specified delay and action listener.

Parameters:

delay - delay between timer cycles

listener - action listener

WebTimer

public WebTimer(long delay,
                @Nullable
                ActionListener listener)

Constructs timer with specified delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

listener - action listener

WebTimer

public WebTimer(@NotNull
                String name,
                @NotNull
                String delay,
                @Nullable
                ActionListener listener)

Constructs timer with specified internal thread name, delay and action listener.

Parameters:

name - internal thread name

delay - delay between timer cycles

listener - action listener

WebTimer

public WebTimer(@NotNull
                String name,
                long delay,
                @Nullable
                ActionListener listener)

Constructs timer with specified internal thread name, delay and action listener.

Parameters:

name - internal thread name

delay - delay between timer cycles in milliseconds

listener - action listener

WebTimer

public WebTimer(long delay,
                long initialDelay,
                @Nullable
                ActionListener listener)

Constructs timer with specified delay, initial delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

listener - action listener

WebTimer

public WebTimer(@NotNull
                String name,
                String delay,
                @NotNull
                String initialDelay,
                @Nullable
                ActionListener listener)

Constructs timer with specified internal thread name, delay, initial delay and action listener.

Parameters:

name - internal thread name

delay - delay between timer cycles

initialDelay - delay before the first timer cycle run

listener - action listener

WebTimer

public WebTimer(@NotNull
                String name,
                long delay,
                long initialDelay,
                @Nullable
                ActionListener listener)

Constructs timer with specified internal thread name, delay, initial delay and action listener.

Parameters:

name - internal thread name

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

listener - action listener

Method Detail

getInitialDelay

public long getInitialDelay()

Returns delay before the first timer cycle run in milliseconds.

Returns:

delay before the first timer cycle run in milliseconds

getInitialStringDelay

@NotNull
public String getInitialStringDelay()

Returns delay before the first timer cycle run.

Returns:

delay before the first timer cycle run

setInitialDelay

@NotNull
public WebTimer setInitialDelay(@NotNull
                                         String initialDelay)

Sets delay before the first timer cycle run.

Parameters:

initialDelay - delay before the first timer cycle run

Returns:

this WebTimer

setInitialDelay

@NotNull
public WebTimer setInitialDelay(long initialDelay)

Sets delay before the first timer cycle run in milliseconds.

Parameters:

initialDelay - delay before the first timer cycle run in milliseconds

Returns:

this WebTimer

getDelay

public long getDelay()

Returns delay between timer cycles in milliseconds.

Returns:

delay between timer cycles in milliseconds

getStringDelay

@NotNull
public String getStringDelay()

Returns delay between timer cycles.

Returns:

delay between timer cycles

setDelay

@NotNull
public WebTimer setDelay(@NotNull
                                  String delay)

Sets delay between timer cycles.

Parameters:

delay - delay between timer cycles

Returns:

this WebTimer

setDelay

@NotNull
public WebTimer setDelay(long delay)

Sets delay between timer cycles in milliseconds.

Parameters:

delay - delay between timer cycles in milliseconds

Returns:

this WebTimer

isRepeats

public boolean isRepeats()

Returns whether timer repeat its cycles or not.

Returns:

true if timer repeat its cycles, false otherwise

setRepeats

@NotNull
public WebTimer setRepeats(boolean repeats)

Sets whether timer should repeat its cycles or not.

Parameters:

repeats - whether timer should repeat its cycles or not

Returns:

this WebTimer

isCoalesce

public boolean isCoalesce()

Returns whether each action should be fired from a separate invoke and wait call or not.

Returns:

true if each action should be fired from a separate invoke and wait call, false otherwise

setCoalesce

@NotNull
public WebTimer setCoalesce(boolean coalesce)

Sets whether each action should be fired from a separate invoke and wait call or not.

Parameters:

coalesce - whether each action should be fired from a separate invoke and wait call or not

Returns:

this WebTimer

isUseEventDispatchThread

public boolean isUseEventDispatchThread()

Returns whether actions should be fired from Event Dispatch Thread or not.

Returns:

true if actions should be fired from Event Dispatch Thread, false otherwise

setUseEventDispatchThread

@NotNull
public WebTimer setUseEventDispatchThread(boolean useEventDispatchThread)

Sets whether actions should be fired from Event Dispatch Thread or not.

Parameters:

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

Returns:

this WebTimer

isUseDaemonThread

public boolean isUseDaemonThread()

Returns whether should use daemon thread instead of user one or not.

Returns:

true if should use daemon thread instead of user one, false otherwise

setUseDaemonThread

@NotNull
public WebTimer setUseDaemonThread(boolean useDaemonThread)

Returns whether should use daemon thread instead of user one or not. If set to true it will allow JVM to shutdown even if timer is still running. This option should be set before starting timer to have any effect.

Parameters:

useDaemonThread - whether should use daemon thread instead of user one or not

Returns:

this WebTimer

isNonBlockingStop

public boolean isNonBlockingStop()

Returns whether or not timer should use non-blocking stop method behavior.

Returns:

true if timer should use non-blocking stop method behavior, false otherwise

setNonBlockingStop

@NotNull
public WebTimer setNonBlockingStop(boolean nonBlockingStop)

Sets whether or not timer should use non-blocking stop method behavior.

Parameters:

nonBlockingStop - whether or not timer should use non-blocking stop method behavior

Returns:

this WebTimer

getActionCommand

@NotNull
public String getActionCommand()

Returns action command for fired events.

Returns:

action command for fired events

setActionCommand

@NotNull
public WebTimer setActionCommand(@NotNull
                                          String actionCommand)

Sets action command for fired events.

Parameters:

actionCommand - action command for fired events

Returns:

this WebTimer

getCyclesLimit

public int getCyclesLimit()

Returns timer cycles execution limit.

Returns:

timer cycles execution limit

setCyclesLimit

@NotNull
public WebTimer setCyclesLimit(int cyclesLimit)

Sets timer cycles execution limit. Zero and less = unlimited amount of execution cycles.

Parameters:

cyclesLimit - timer cycles execution limit

Returns:

this WebTimer

getName

@NotNull
public String getName()

Returns internal timer thread name.

Returns:

internal timer thread name

setName

@NotNull
public WebTimer setName(@NotNull
                                 String name)

Sets internal timer thread name.

Parameters:

name - internal timer thread name

Returns:

this WebTimer

getCycleTimePassed

public long getCycleTimePassed()

Returns time passed in milliseconds since current cycle start. Cycle includes its delay time and execution time.

Returns:

time passed in milliseconds since current cycle start

getCycleTimeLeft

public long getCycleTimeLeft()

Returns time left in milliseconds until current cycle action execution.

Returns:

time left in milliseconds until current cycle action execution

getCycleCount

public int getCycleCount()

Returns executed cycles count. This number changes only after cycle execution (including action execution).

Returns:

executed cycles count

getCycleNumber

public int getCycleNumber()

Returns current cycle number. This number changes only after cycle execution (including action execution).

Returns:

current cycle number

isLastCycle

public boolean isLastCycle()

Return whether last cycle execution is ongoing or not.

Returns:

true if last cycle execution is ongoing, false otherwise

start

@NotNull
public WebTimer start()

Starts timer execution.

Returns:

this WebTimer

stop

@NotNull
public WebTimer stop()

Stops timer execution.

Returns:

this WebTimer

restart

@NotNull
public WebTimer restart()

Restarts timer execution.

Returns:

this WebTimer

restart

@NotNull
public WebTimer restart(long delay)

Restarts timer execution and modifies timer delay.

Parameters:

delay - delay between timer cycles

Returns:

this WebTimer

restart

@NotNull
public WebTimer restart(long initialDelay,
                                 long delay)

Restarts timer execution and modifies timer delays.

Parameters:

initialDelay - delay before the first timer cycle run

delay - delay between timer cycles

Returns:

this WebTimer

restart

@NotNull
public WebTimer restart(@NotNull
                                 String delay)

Restarts timer execution and modifies timer delay.

Parameters:

delay - delay between timer cycles

Returns:

this WebTimer

restart

@NotNull
public WebTimer restart(@NotNull
                                 String initialDelay,
                                 @NotNull
                                 String delay)

Restarts timer execution and modifies timer delays.

Parameters:

initialDelay - delay before the first timer cycle run

delay - delay between timer cycles

Returns:

this WebTimer

isRunning

public boolean isRunning()

Returns whether this WebTimer is running or not.

Returns:

true if this WebTimer is running, false otherwise

startExec

protected void startExec()

Starts timer execution thread.

shouldContinue

protected boolean shouldContinue(int cycle,
                                 int id)

Returns whether thread with specified ID should continue execution or not.

Parameters:

cycle - cycle number

id - execution thread ID

Returns:

true if thread with specified ID should continue execution, false otherwise

setAlive

protected void setAlive(int id,
                        boolean alive)

Sets whether thread under specified ID is alive or not.

Parameters:

id - thread ID

alive - whether thread is alive or not

cleanUp

protected void cleanUp(int id)

Cleans thread ID cache.

Parameters:

id - thread ID

stopExec

protected void stopExec()

Stops timer execution.

addActionListener

@NotNull
public WebTimer addActionListener(@NotNull
                                           ActionListener listener)

Adds new action listener. You can use TimerActionListener instead of simple ActionListener to simplify interaction with timer.

Parameters:

listener - new action listener

Returns:

this WebTimer

removeActionListener

@NotNull
public WebTimer removeActionListener(@NotNull
                                              ActionListener listener)

Removes an action listener.

Parameters:

listener - action listener

Returns:

this WebTimer

getListeners

@NotNull
public List<ActionListener> getListeners()

Returns available action listeners list.

Returns:

available action listeners list

fireActionPerformed

public void fireActionPerformed(int id)

Fires action events.

Parameters:

id - execution thread ID

createActionEvent

@NotNull
protected ActionEvent createActionEvent()

Returns action event.

Returns:

action event

toString

@NotNull
public String toString()

Overrides:

toString in class Object

delay

public static WebTimer delay(@NotNull
                             String delay,
                             @Nullable
                             ActionListener listener)

Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles

listener - action listener

Returns:

newly created and started timer

delay

public static WebTimer delay(long delay,
                             @Nullable
                             ActionListener listener)

Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

listener - action listener

Returns:

newly created and started timer

delay

public static WebTimer delay(@NotNull
                             String name,
                             @NotNull
                             String delay,
                             @Nullable
                             ActionListener listener)

Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles

listener - action listener

Returns:

newly created and started timer

delay

public static WebTimer delay(@NotNull
                             String name,
                             long delay,
                             @Nullable
                             ActionListener listener)

Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

listener - action listener

Returns:

newly created and started timer

delay

public static WebTimer delay(@NotNull
                             String delay,
                             boolean useEventDispatchThread,
                             @Nullable
                             ActionListener listener)

Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

delay

public static WebTimer delay(long delay,
                             boolean useEventDispatchThread,
                             @Nullable
                             ActionListener listener)

Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

delay

public static WebTimer delay(@NotNull
                             String name,
                             @NotNull
                             String delay,
                             boolean useEventDispatchThread,
                             @Nullable
                             ActionListener listener)

Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

delay

public static WebTimer delay(@NotNull
                             String name,
                             long delay,
                             boolean useEventDispatchThread,
                             @Nullable
                             ActionListener listener)

Returns newly created and started timer that doesn't repeat and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String delay,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String delay,
                              int cyclesLimit,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles

cyclesLimit - timer cycles execution limit

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(long delay,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(long delay,
                              int cyclesLimit,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

cyclesLimit - timer cycles execution limit

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              @NotNull
                              String delay,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              String delay,
                              int cyclesLimit,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles

cyclesLimit - timer cycles execution limit

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              long delay,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              long delay,
                              int cyclesLimit,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

cyclesLimit - timer cycles execution limit

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String delay,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String delay,
                              int cyclesLimit,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles

cyclesLimit - timer cycles execution limit

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(long delay,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(long delay,
                              int cyclesLimit,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

cyclesLimit - timer cycles execution limit

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              @NotNull
                              String delay,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              @NotNull
                              String delay,
                              int cyclesLimit,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles

cyclesLimit - timer cycles execution limit

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              long delay,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              long delay,
                              int cyclesLimit,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

cyclesLimit - timer cycles execution limit

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(long delay,
                              long initialDelay,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(long delay,
                              long initialDelay,
                              int cyclesLimit,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

cyclesLimit - timer cycles execution limit

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              long delay,
                              long initialDelay,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              long delay,
                              long initialDelay,
                              int cyclesLimit,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

cyclesLimit - timer cycles execution limit

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(long delay,
                              long initialDelay,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(long delay,
                              long initialDelay,
                              int cyclesLimit,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

cyclesLimit - timer cycles execution limit

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              long delay,
                              long initialDelay,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(@NotNull
                              String name,
                              long delay,
                              long initialDelay,
                              int cyclesLimit,
                              boolean useEventDispatchThread,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

name - thread name

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

cyclesLimit - timer cycles execution limit

useEventDispatchThread - whether actions should be fired from Event Dispatch Thread or not

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(boolean useDaemonThread,
                              @NotNull
                              String name,
                              long delay,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

useDaemonThread - whether should use daemon thread instead of user one or not

name - thread name

delay - delay between timer cycles in milliseconds

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(boolean useDaemonThread,
                              @NotNull
                              String name,
                              long delay,
                              long initialDelay,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

useDaemonThread - whether should use daemon thread instead of user one or not

name - thread name

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

listener - action listener

Returns:

newly created and started timer

repeat

public static WebTimer repeat(boolean useDaemonThread,
                              @NotNull
                              String name,
                              long delay,
                              long initialDelay,
                              int cyclesLimit,
                              @Nullable
                              ActionListener listener)

Returns newly created and started timer that repeats and has the specified delay, initial delay and action listener.

Parameters:

useDaemonThread - whether should use daemon thread instead of user one or not

name - thread name

delay - delay between timer cycles in milliseconds

initialDelay - delay before the first timer cycle run in milliseconds

cyclesLimit - timer cycles execution limit

listener - action listener

Returns:

newly created and started timer