ch.awae.utils.sequence

Class Sequence

java.lang.Object

ch.awae.utils.sequence.Sequence

public final class Sequence
extends java.lang.Object

Sequence allows for sequential construction of a sequence of code blocks. Sequences may contain (nested) loops. Sequences usually run in their own thread that can be started and stopped. Stopping the Sequence tries to interrupt the execution as soon as possible. If a step accepts the interrupt by throwing an InterruptedException the sequence is aborted. In any case the sequence is aborted as soon as the step running while calling stop() terminates.

Since:

awaeUtils 0.0.6

Author:

Andreas Wälchli

Constructor Summary

Constructors

Constructor and Description
Sequence(InterruptibleRunnable base) Wrap an InterruptibleRunnable into a sequence instance

Method Summary

Modifier and Type	Method and Description
static IRootSequenceBuilder	builder() Creates a new sequence builder
void	join() Waits for the currently running instance of this sequence to terminate.
void	start() Starts the sequence.
void	stop() Stops the sequence.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sequence

public Sequence(InterruptibleRunnable base)

Wrap an InterruptibleRunnable into a sequence instance

Method Detail

start

public void start()
           throws java.lang.InterruptedException

Starts the sequence. If the sequence is already running it is terminated and restarted. The termination is done by calling stop() and is therefore blocking.

Throws:

java.lang.InterruptedException - if the calling thread is interrupted while waiting for the previous instance of this sequence to terminate.

See Also:

stop()

join

public void join()
          throws java.lang.InterruptedException

Waits for the currently running instance of this sequence to terminate. If the sequence is not currently running this method does nothing. This does not stop the sequence.

Throws:

java.lang.InterruptedException - if the calling thread is interrupted while waiting for the running instance of this sequence to terminate.

stop

public void stop()
          throws java.lang.InterruptedException

Stops the sequence. If the sequence is not running this method does nothing. The termination of a sequence is blocking.

Throws:

java.lang.InterruptedException - if the calling thread is interrupted while waiting for the running instance of this sequence to terminate.

builder

public static IRootSequenceBuilder builder()

Creates a new sequence builder