org.tools4j.nobark.loop

Class Loop

java.lang.Object

org.tools4j.nobark.loop.Loop

All Implemented Interfaces:

java.lang.Runnable

public class Loop
extends java.lang.Object
implements java.lang.Runnable

A loop performing a series of steps in an iterative manner as long as the LoopCondition is true. If no step performs any work in a whole iteration, an IdleStrategy is invoked.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Loop	mainLoop(LoopCondition loopCondition, IdleStrategy idleStrategy, ExceptionHandler exceptionHandler, StepProvider... stepProviders) Static factory method creating a loop with normal steps using the given providers to construct the loop steps.
void	run()
static Loop	shutdownLoop(LoopCondition loopCondition, IdleStrategy idleStrategy, ExceptionHandler exceptionHandler, StepProvider... stepProviders) Static factory method creating a loop with shutdown steps using the given providers to construct the loop steps.
static StoppableThread	start(IdleStrategy idleStrategy, ExceptionHandler exceptionHandler, java.util.concurrent.ThreadFactory threadFactory, Step... steps) Creates, starts and returns a new thread running a loop with the given steps.
static ShutdownableThread	start(IdleStrategy idleStrategy, ExceptionHandler exceptionHandler, java.util.concurrent.ThreadFactory threadFactory, StepProvider... stepProviders) Creates, starts and returns a new thread running first a main loop and then another shutdown loop during the graceful shutdown phase.

Methods inherited from class java.lang.Object

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

Constructor Detail

Loop

public Loop(LoopCondition loopCondition,
            IdleStrategy idleStrategy,
            ExceptionHandler exceptionHandler,
            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

steps - the steps executed in the loop

Method Detail

mainLoop

public static Loop mainLoop(LoopCondition loopCondition,
                            IdleStrategy idleStrategy,
                            ExceptionHandler exceptionHandler,
                            StepProvider... stepProviders)

Static factory method creating a loop with normal steps using the given providers to construct the loop steps.

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

stepProviders - the providers for the steps executed during the loop

Returns:

new loop with steps to execute in the normal phase of a process

shutdownLoop

public static Loop shutdownLoop(LoopCondition loopCondition,
                                IdleStrategy idleStrategy,
                                ExceptionHandler exceptionHandler,
                                StepProvider... stepProviders)

Static factory method creating a loop with shutdown steps using the given providers to construct the loop steps.

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

stepProviders - the providers for the steps executed during the loop

Returns:

new loop with steps to execute in the shutdown phase of a process

start

public static StoppableThread start(IdleStrategy idleStrategy,
                                    ExceptionHandler exceptionHandler,
                                    java.util.concurrent.ThreadFactory threadFactory,
                                    Step... steps)

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

steps - the steps executed during the loop

Returns:

the newly created and started thread running the loop

start

public static ShutdownableThread start(IdleStrategy idleStrategy,
                                       ExceptionHandler exceptionHandler,
                                       java.util.concurrent.ThreadFactory threadFactory,
                                       StepProvider... stepProviders)

Creates, starts and returns a new thread running first a main loop and then another shutdown loop during the graceful shutdown phase. The loops are created with steps constructed with the given providers using normal steps for the main loop and shutdown steps for the shutdown loop.

Parameters:

idleStrategy - the strategy handling idle main loop phases

exceptionHandler - the step exception handler

threadFactory - the factory to provide the service thread

stepProviders - the providers for the steps executed during the loop

Returns:

the newly created and started thread running the loop

run

public void run()

Specified by:

run in interface java.lang.Runnable