org.dice_research.topicmodeling.concurrent.tasks.waiting

Class AbstractWaitingTask

java.lang.Object

org.dice_research.topicmodeling.concurrent.tasks.waiting.AbstractWaitingTask

All Implemented Interfaces:

Runnable, Task, WaitingTask

public abstract class AbstractWaitingTask
extends Object
implements WaitingTask

This abstract class offers simple methods to implement the needed functionality of a WaitingTask. Inside the implementation the methods startWaiting() and stopWaiting() should be used before and after the task entered the section in which it has to wait.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	NOT_WAITING_SENTINEL
protected long	waitingStarted The time stamp at which the current task started waiting.

Constructor Summary

Constructors

Constructor and Description
AbstractWaitingTask()

Method Summary

Modifier and Type	Method and Description
long	getTimeWaiting() Returns the time the task is already waiting.
protected void	startWaiting() This method should be called before the task enters the section in which it might wait a long time.
protected void	stopWaiting() This method should be called after the task has finished the section in which it might wait a long time.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dice_research.topicmodeling.concurrent.tasks.Task

getId, getProgress

Methods inherited from interface java.lang.Runnable

run

Field Detail

NOT_WAITING_SENTINEL

protected static final long NOT_WAITING_SENTINEL

See Also:

Constant Field Values

waitingStarted

protected long waitingStarted

The time stamp at which the current task started waiting.

Constructor Detail

AbstractWaitingTask

public AbstractWaitingTask()

Method Detail

getTimeWaiting

public long getTimeWaiting()

Description copied from interface: WaitingTask

Returns the time the task is already waiting.

Specified by:

getTimeWaiting in interface WaitingTask

Returns:

the time in milliseconds

startWaiting

protected void startWaiting()

This method should be called before the task enters the section in which it might wait a long time.

stopWaiting

protected void stopWaiting()

This method should be called after the task has finished the section in which it might wait a long time.