au.gov.nehta.common.utils

Class AbstractProcessScheduler

java.lang.Object

java.lang.Thread

au.gov.nehta.common.utils.AbstractProcessScheduler

All Implemented Interfaces:

Runnable

public abstract class AbstractProcessScheduler
extends Thread

This class facilitates the java process to run periodically for the specified time interval. This scheduled thread can be stopped, restarted and cancelled.

Author:

VinSekar

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractProcessScheduler(int interval) Default constructor with accepts the time interval as an argument.

Method Summary

Modifier and Type	Method and Description
boolean	isThreadRunning() This method returns true if the timer thread is running.
abstract void	performThreadTask() Implement the piece of code to be executed for the scheduled time interval.
void	run()
void	runPeriodically() This method runs the current thread periodically for the provided interval.
void	startThread() This method starts the scheduler thread.
void	stopTimerThread() This method stops the scheduled thread.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProcessScheduler

public AbstractProcessScheduler(int interval)

Default constructor with accepts the time interval as an argument.

Parameters:

interval -

Method Detail

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

runPeriodically

public void runPeriodically()

This method runs the current thread periodically for the provided interval.

performThreadTask

public abstract void performThreadTask()

Implement the piece of code to be executed for the scheduled time interval.

stopTimerThread

public void stopTimerThread()

This method stops the scheduled thread. This method is thread safe.

startThread

public void startThread()

This method starts the scheduler thread. This method is thread safe.

isThreadRunning

public boolean isThreadRunning()

This method returns true if the timer thread is running.

Returns:

true if timer thread is running