org.tools4j.elara.loop

Class ElaraLoop

java.lang.Object

org.tools4j.nobark.loop.Loop

org.tools4j.elara.loop.ElaraLoop

All Implemented Interfaces:

Runnable

public class ElaraLoop
extends Loop

Extension of nobark Loop allowing for an initialisation step executed in the elera thread before the loop. The static start(..) method takes the RunnerFactory and initialises most elara objects on the target thread.

Constructor Summary

Constructors

Constructor and Description
ElaraLoop(LoopCondition loopCondition, IdleStrategy idleStrategy, ExceptionHandler exceptionHandler, Runnable initStep, Step... steps) Constructor with loop condition, idle strategy, step exception handler and the steps to perform.

Method Summary

Modifier and Type	Method and Description
void	run()
static StoppableThread	start(IdleStrategy idleStrategy, ExceptionHandler exceptionHandler, ThreadFactory threadFactory, RunnerFactory runnerFactory) Creates, starts and returns a new thread running a loop with the given steps.

Methods inherited from class org.tools4j.nobark.loop.Loop

mainLoop, shutdownLoop, start, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ElaraLoop

public ElaraLoop(LoopCondition loopCondition,
                 IdleStrategy idleStrategy,
                 ExceptionHandler exceptionHandler,
                 Runnable initStep,
                 Step... steps)

Constructor with loop condition, idle strategy, step exception handler and the steps to perform.

Parameters:

loopCondition - the condition defining when the loop terminates

idleStrategy - the idle strategy defining how to handle situations without work to do

exceptionHandler - the handler for step exceptions

initStep - initialisation step run once before running the loop

steps - the steps executed in the loop

Method Detail

start

public static StoppableThread start(IdleStrategy idleStrategy,
                                    ExceptionHandler exceptionHandler,
                                    ThreadFactory threadFactory,
                                    RunnerFactory runnerFactory)

Creates, starts and returns a new thread running a loop with the given steps.

Parameters:

idleStrategy - the strategy handling idle loop phases

exceptionHandler - the step exception handler

threadFactory - the factory to provide the service thread

runnerFactory - factory to create the objects to run on the elara thread

Returns:

the newly created and started thread running the loop

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Loop