ch.awae.utils.concurrent

Class IterativeRunner

java.lang.Object

ch.awae.utils.concurrent.IterativeRunner

All Implemented Interfaces:

java.lang.Runnable

public abstract class IterativeRunner
extends java.lang.Object
implements java.lang.Runnable

This prebuilt Runnable implementation allows for a very simple implementation. It consists of an infinite loop with a user provided step implementation. Before the first step a start handler is called.According to indication of the step implementation the base loop can be terminated. If the step yields an interrupt, the loop is terminated as well. After loop termination a termination handling method is called, after an interrupt handler has been run in case of an interrupt being the reason for the loop termination.

Since:

awaeUtils 1.0.0

Author:

Andreas Wälchli

Constructor Summary

Constructors

Constructor and Description
IterativeRunner()

Method Summary

Modifier and Type	Method and Description
protected void	onInterrupt() This method is invoked if an interrupt is detected.
protected void	onStart() This method is invoked before the first iteration step.
protected void	onTerminate() This method is invoked whenever the iteration is terminated.
void	run()
protected abstract boolean	step() This method is invoked once each iteration step.

Methods inherited from class java.lang.Object

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

Constructor Detail

IterativeRunner

public IterativeRunner()

Method Detail

run

public final void run()

Specified by:

run in interface java.lang.Runnable

step

protected abstract boolean step()
                         throws java.lang.InterruptedException

This method is invoked once each iteration step.

Returns:

true if the iteration should proceed, false if it should terminate.

Throws:

java.lang.InterruptedException - if the iteration was interrupted and should be terminated using the interrupt shutdown procedure

onInterrupt

protected void onInterrupt()

This method is invoked if an interrupt is detected. The implementation of must always return normally.

onTerminate

protected void onTerminate()

This method is invoked whenever the iteration is terminated. This allows for the implementation of cleanup code. If the termination was due to an interrupt, onInterrupt() will be invoked before this method.

onStart

protected void onStart()

This method is invoked before the first iteration step. This allows for the implementation of setup code.