ch.awae.utils.statemachine

Class EventGenerator

java.lang.Object

ch.awae.utils.statemachine.EventGenerator

public final class EventGenerator
extends java.lang.Object

Asynchronous event generation.

Periodically repeat a fixed event or an event provided by a supplier function.

Since:

awaeUtils 0.0.5

Version:

1.1

Author:

Andreas Wälchli

See Also:

StateMachine

Constructor Summary

Constructors

Constructor and Description
EventGenerator(StateMachine machine, java.lang.String event, long delay) creates a new event generator for a given event
EventGenerator(StateMachine machine, java.util.function.Supplier<java.lang.String> supplier, long delay) creates a new event generator based off a Supplier function.

Method Summary

Modifier and Type	Method and Description
void	start() starts the event generator
void	stop() stops the event generator.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventGenerator

public EventGenerator(StateMachine machine,
                      java.lang.String event,
                      long delay)

creates a new event generator for a given event

Parameters:

machine - the state machine to pass the events to

event - the event to pass to the state machine

delay - the delay in milliseconds between events. this is an approximate value and is subject to variations due to the system thread scheduler.

Throws:

java.lang.NullPointerException - the machine or event is null

java.lang.IllegalArgumentException - the delay is zero or negative

EventGenerator

public EventGenerator(StateMachine machine,
                      java.util.function.Supplier<java.lang.String> supplier,
                      long delay)

creates a new event generator based off a Supplier function. It is required that the supplier function does never return null values as null events are not supported by the StateMachine. If the supplier ever returns a null value the worker thread of this generator will terminate with a NullPointerException. The instance will however ensure that it can be restarted.

Parameters:

machine - the state machine to pass the events to

supplier - the event supplier providing the events to pass to the state machine

delay - the delay in milliseconds between events. this is an approximate value and is subject to variations due to the system thread scheduler.

Throws:

java.lang.NullPointerException - the machine or supplier is null

java.lang.IllegalArgumentException - the delay is zero or negative

Method Detail

start

public void start()

starts the event generator

Throws:

java.lang.IllegalStateException - the generator is already running

stop

public void stop()

stops the event generator. blocks until the generator terminates

Throws:

java.lang.IllegalStateException - the generator is not running