de.ipcon.tools.scheduler

Class FixedTimeScheduler

java.lang.Object

java.util.Timer

de.ipcon.tools.scheduler.FixedTimeScheduler

Direct Known Subclasses:

AlarmScheduler

public class FixedTimeScheduler
extends java.util.Timer

Class that will call the onSchedulablesTriggered() method of the given SchedulableHandlerI at a requested time, which time can be updated as required.

Constructor Summary

Constructors

Constructor and Description
FixedTimeScheduler(SchedulableHandlerI _sh)

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	deactivate(java.lang.String reason) Cancels the currently active task, if there is one.
org.apache.log4j.Logger	getLogger()
boolean	isActive() Tells if some task is scheduled currently.
void	schedule(java.util.TimerTask task, java.util.Date time)
void	schedule(java.util.TimerTask task, java.util.Date firstTime, long period)
void	schedule(java.util.TimerTask task, long delay)
void	schedule(java.util.TimerTask task, long delay, long period)
void	scheduleAtFixedRate(java.util.TimerTask task, java.util.Date firstTime, long period)
void	scheduleAtFixedRate(java.util.TimerTask task, long delay, long period)
void	updateTriggeringDate(java.util.Date shouldTriggerNextAt, java.lang.String reason) Updates the triggering date as requested.
void	updateTriggeringDate(java.util.Date shouldTriggerNextAt, java.lang.String reason, java.lang.String dateSourceInfo)

Methods inherited from class java.util.Timer

purge

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedTimeScheduler

public FixedTimeScheduler(SchedulableHandlerI _sh)

Method Detail

getLogger

public org.apache.log4j.Logger getLogger()

updateTriggeringDate

public void updateTriggeringDate(java.util.Date shouldTriggerNextAt,
                                 java.lang.String reason)

Updates the triggering date as requested.

Parameters:

shouldTriggerNextAt - the new triggering date; if the same as the currently set one will do nothing; must not be null

reason - a string with the reason for the update, used (only) in log messages for debugging purposes; must not be null

dateSourceInfo - info from which source the new date is coming from, logged to help debugging and analysis; may be null

updateTriggeringDate

public void updateTriggeringDate(java.util.Date shouldTriggerNextAt,
                                 java.lang.String reason,
                                 java.lang.String dateSourceInfo)

cancel

public void cancel()

Overrides:

cancel in class java.util.Timer

schedule

public void schedule(java.util.TimerTask task,
                     java.util.Date time)

Overrides:

schedule in class java.util.Timer

schedule

public void schedule(java.util.TimerTask task,
                     long delay)

Overrides:

schedule in class java.util.Timer

schedule

public void schedule(java.util.TimerTask task,
                     long delay,
                     long period)

Overrides:

schedule in class java.util.Timer

schedule

public void schedule(java.util.TimerTask task,
                     java.util.Date firstTime,
                     long period)

Overrides:

schedule in class java.util.Timer

scheduleAtFixedRate

public void scheduleAtFixedRate(java.util.TimerTask task,
                                long delay,
                                long period)

Overrides:

scheduleAtFixedRate in class java.util.Timer

scheduleAtFixedRate

public void scheduleAtFixedRate(java.util.TimerTask task,
                                java.util.Date firstTime,
                                long period)

Overrides:

scheduleAtFixedRate in class java.util.Timer

isActive

public boolean isActive()

Tells if some task is scheduled currently.

Returns:

true if a task is currently scheduled; false if that is not the case and no triggering will take place

deactivate

public void deactivate(java.lang.String reason)

Cancels the currently active task, if there is one.