jarol
Interface TimeTriggerInterface

All Known Implementing Classes:
TimeTrigger

public interface TimeTriggerInterface

TimeTriggerInterface should be implemented by any class whose instances should provide a periodic "Tick" on watchers.

Version:
0.1
Author:
Bernhard Kast

Method Summary
 void await()
          Causes the calling task to be suspended until the period is finished.
 int getPeriod()
          Returns the current period.
 void setPeriod(int period)
          Sets the period in milliseconds.
 void stopExecution()
          Stops the execution of the thread.
 

Method Detail

await

void await()
           throws AwaitDuringSignalingException
Causes the calling task to be suspended until the period is finished.

Throws:
AwaitDuringSignalingException

setPeriod

void setPeriod(int period)
Sets the period in milliseconds.

Parameters:
period - - The period in milliseconds.

getPeriod

int getPeriod()
Returns the current period.

Returns:
- The current period in milliseconds.

stopExecution

void stopExecution()
Stops the execution of the thread.