ch.awae.utils.statemachine

Class MachineCoreBuilder

java.lang.Object

ch.awae.utils.statemachine.MachineCoreBuilder

public final class MachineCoreBuilder
extends java.lang.Object

Builder for constructing state machine cores. multiple of these builders can be combined in a StateMachineBuilder to construct a state machine.

A machine core describes a single state machine with exactly one active state at any time. Multiple cores can be combined into a StateMachine at which point they are combined into a state machine cluster with common event and command queues.

The builder does perform some preliminary data validation on every mutation. A full data validation is performed by the StateMachineBuilder whenever a core is added.

Since:

awaeUtils 0.0.3

Version:

1.2 (0.0.4)

Author:

Andreas Wälchli

See Also:

StateMachine, StateMachineBuilder

Constructor Summary

Constructors

Constructor and Description
MachineCoreBuilder() creates a new empty builder
MachineCoreBuilder(MachineCoreBuilder builder) copy constructor

Method Summary

Modifier and Type	Method and Description
MachineCoreBuilder	addTransition(java.lang.String from, java.lang.String event, java.lang.String to, java.lang.String[] events, java.lang.String[] commands) Adds a new transition between two states.
MachineCoreBuilder	copy() creates a copy of this builder instance.
MachineCoreBuilder	setInitialState(java.lang.String state) Sets the initial state of the state machine core.

Methods inherited from class java.lang.Object

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

Constructor Detail

MachineCoreBuilder

public MachineCoreBuilder()

creates a new empty builder

MachineCoreBuilder

public MachineCoreBuilder(MachineCoreBuilder builder)

copy constructor

Parameters:

builder - the builder to copy

Throws:

java.lang.NullPointerException - builder is null

Since:

1.2

Method Detail

addTransition

public MachineCoreBuilder addTransition(java.lang.String from,
                                        java.lang.String event,
                                        java.lang.String to,
                                        java.lang.String[] events,
                                        java.lang.String[] commands)

Adds a new transition between two states.

Parameters:

from - the state the transition originates from. may not be null

event - the event that triggers the transition. may not be null

to - the state the transition leads to. may be identical to from. may not be null

events - an array of all events that shall be triggered by the transition. may be null. no element may be null

commands - an array of all commands that shall be triggered by the transition. may be null. no element may be null

Returns:

the builder itself

Throws:

java.lang.NullPointerException - if any String parameter or any array element is null

setInitialState

public MachineCoreBuilder setInitialState(java.lang.String state)

Sets the initial state of the state machine core. The initial state is the state the state machine will start at and return to whenever it is reset.

Parameters:

state - the initial state. may not be null

Returns:

the builder itself

Throws:

java.lang.NullPointerException - state is null

copy

public MachineCoreBuilder copy()

creates a copy of this builder instance.

Returns:

a copy

Since:

1.2

See Also:

MachineCoreBuilder(MachineCoreBuilder)