ch.awae.utils.statemachine

Class CommandProcessor

java.lang.Object

ch.awae.utils.statemachine.CommandProcessor

public final class CommandProcessor
extends java.lang.Object

A command processor that handles commands asynchronously directly from the command queue of a StateMachine.

Since:

awaeUtils 0.0.5

Version:

1.1

Author:

Andreas Wälchli

See Also:

StateMachine

Constructor Summary

Constructors

Constructor and Description
CommandProcessor(StateMachine machine, java.util.function.Consumer<java.lang.String> handler) creates a new command processor from a StateMachine.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandProcessor

public CommandProcessor(StateMachine machine,
                        java.util.function.Consumer<java.lang.String> handler)

creates a new command processor from a StateMachine. It hooks directly into the command queue of that StateMachine and handles each command through a defined handling routine.

Parameters:

machine - the state machine to process commands for. may not be null

handler - a handler function defining the way each command is handled. may not be null

Throws:

java.lang.NullPointerException - a parameter is null

See Also:

StateMachine

Method Detail

start

public void start()

starts the processor

Throws:

java.lang.IllegalStateException - the processor is already running

stop

public void stop()

stops the processor. blocks until the processor has terminated

Throws:

java.lang.IllegalStateException - the processor is not running