org.springframework.scheduling.commonj

Class ScheduledTimerListener

java.lang.Object

org.springframework.scheduling.commonj.ScheduledTimerListener

public class ScheduledTimerListener
extends java.lang.Object

JavaBean that describes a scheduled TimerListener, consisting of the TimerListener itself (or a Runnable to create a TimerListener for) and a delay plus period. Period needs to be specified; there is no point in a default for it.

The CommonJ TimerManager does not offer more sophisticated scheduling options such as cron expressions. Consider using Quartz for such advanced needs.

Note that the TimerManager uses a TimerListener instance that is shared between repeated executions, in contrast to Quartz which instantiates a new Job for each execution.

Since:

2.0

Author:

Juergen Hoeller

See Also:

commonj.timers.TimerListener, commonj.timers.TimerManager#schedule(commonj.timers.TimerListener, long, long), commonj.timers.TimerManager#scheduleAtFixedRate(commonj.timers.TimerListener, long, long)

Field Summary

Fields

Modifier and Type	Field and Description
private long	delay
private boolean	fixedRate
private long	period
private TimerListener	timerListener

Constructor Summary

Constructors

Constructor and Description
ScheduledTimerListener() Create a new ScheduledTimerListener, to be populated via bean properties.
ScheduledTimerListener(TimerListener timerListener) Create a new ScheduledTimerListener, with default one-time execution without delay.
ScheduledTimerListener(TimerListener timerListener, long delay) Create a new ScheduledTimerListener, with default one-time execution with the given delay.
ScheduledTimerListener(TimerListener timerListener, long delay, long period, boolean fixedRate) Create a new ScheduledTimerListener.

Method Summary

Modifier and Type	Method and Description
long	getDelay() Return the delay before starting the job for the first time.
long	getPeriod() Return the period between repeated task executions.
TimerListener	getTimerListener() Return the TimerListener to schedule.
boolean	isFixedRate() Return whether to schedule as fixed-rate execution.
boolean	isOneTimeTask() Is this task only ever going to execute once?
void	setDelay(long delay) Set the delay before starting the task for the first time, in milliseconds.
void	setFixedRate(boolean fixedRate) Set whether to schedule as fixed-rate execution, rather than fixed-delay execution.
void	setPeriod(long period) Set the period between repeated task executions, in milliseconds.
void	setRunnable(java.lang.Runnable timerTask) Set the Runnable to schedule as TimerListener.
void	setTimerListener(TimerListener timerListener) Set the TimerListener to schedule.

Methods inherited from class java.lang.Object

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

Field Detail

timerListener

private TimerListener timerListener

delay

private long delay

period

private long period

fixedRate

private boolean fixedRate

Constructor Detail

ScheduledTimerListener

public ScheduledTimerListener()

Create a new ScheduledTimerListener, to be populated via bean properties.

See Also:

setTimerListener(TimerListener), setDelay(long), setPeriod(long), setFixedRate(boolean)

ScheduledTimerListener

public ScheduledTimerListener(TimerListener timerListener)

Create a new ScheduledTimerListener, with default one-time execution without delay.

Parameters:

timerListener - the TimerListener to schedule

ScheduledTimerListener

public ScheduledTimerListener(TimerListener timerListener,
                              long delay)

Create a new ScheduledTimerListener, with default one-time execution with the given delay.

Parameters:

timerListener - the TimerListener to schedule

delay - the delay before starting the task for the first time (ms)

ScheduledTimerListener

public ScheduledTimerListener(TimerListener timerListener,
                              long delay,
                              long period,
                              boolean fixedRate)

Create a new ScheduledTimerListener.

Parameters:

timerListener - the TimerListener to schedule

delay - the delay before starting the task for the first time (ms)

period - the period between repeated task executions (ms)

fixedRate - whether to schedule as fixed-rate execution

Method Detail

setRunnable

public void setRunnable(java.lang.Runnable timerTask)

Set the Runnable to schedule as TimerListener.

See Also:

DelegatingTimerListener

setTimerListener

public void setTimerListener(TimerListener timerListener)

Set the TimerListener to schedule.

getTimerListener

public TimerListener getTimerListener()

Return the TimerListener to schedule.

setDelay

public void setDelay(long delay)

Set the delay before starting the task for the first time, in milliseconds. Default is 0, immediately starting the task after successful scheduling.

If the "firstTime" property is specified, this property will be ignored. Specify one or the other, not both.

getDelay

public long getDelay()

Return the delay before starting the job for the first time.

setPeriod

public void setPeriod(long period)

Set the period between repeated task executions, in milliseconds.

Default is -1, leading to one-time execution. In case of zero or a positive value, the task will be executed repeatedly, with the given interval inbetween executions.

Note that the semantics of the period value vary between fixed-rate and fixed-delay execution.

Note: A period of 0 (for example as fixed delay) is supported, because the CommonJ specification defines this as a legal value. Hence a value of 0 will result in immediate re-execution after a job has finished (not in one-time execution like with java.util.Timer).

See Also:

setFixedRate(boolean), isOneTimeTask(), commonj.timers.TimerManager#schedule(commonj.timers.TimerListener, long, long)

getPeriod

public long getPeriod()

Return the period between repeated task executions.

isOneTimeTask

public boolean isOneTimeTask()

Is this task only ever going to execute once?

Returns:

true if this task is only ever going to execute once

See Also:

getPeriod()

setFixedRate

public void setFixedRate(boolean fixedRate)

Set whether to schedule as fixed-rate execution, rather than fixed-delay execution. Default is "false", i.e. fixed delay.

See TimerManager javadoc for details on those execution modes.

See Also:

commonj.timers.TimerManager#schedule(commonj.timers.TimerListener, long, long), commonj.timers.TimerManager#scheduleAtFixedRate(commonj.timers.TimerListener, long, long)

isFixedRate

public boolean isFixedRate()

Return whether to schedule as fixed-rate execution.