ch.awae.utils.statemachine

Class StateMachineBuilder

java.lang.Object

ch.awae.utils.statemachine.StateMachineBuilder

public class StateMachineBuilder
extends java.lang.Object

Builder for constructing state machines.

A state machine consists of one or more state machine cores. There cores are constructed using a MachineCoreBuilder.

Since:

awaeUtils 0.0.3

Version:

1.2 (0.0.4)

Author:

Andreas Wälchli

See Also:

StateMachine, MachineCoreBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
StateMachineBuilder	addMachineCore(MachineCoreBuilder builder) Adds a MachineCoreBuilder to this builder.
StateMachine	build() Constructs a StateMachine represented by this builder and all its MachineCoreBuilders
StateMachineBuilder	copy() creates a copy of this builder

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachineBuilder

public StateMachineBuilder()

creates a new empty builder

StateMachineBuilder

public StateMachineBuilder(StateMachineBuilder builder)

copy constructor

Parameters:

builder - the builder to copy

Throws:

java.lang.NullPointerException - builder is null

Since:

1.2

Method Detail

addMachineCore

public StateMachineBuilder addMachineCore(MachineCoreBuilder builder)

Adds a MachineCoreBuilder to this builder. That builder will be used to derive a state machine core internally. The passed MachineCoreBuilder instance will be copied and will therefore not be affected by further changes to that instance.

Parameters:

builder - the core builder to add. may not be null

Returns:

the builder itself

Throws:

java.lang.NullPointerException - builder is null

copy

public StateMachineBuilder copy()

creates a copy of this builder

Returns:

the copy

Since:

1.2

build

public StateMachine build()

Constructs a StateMachine represented by this builder and all its MachineCoreBuilders

Returns:

a state machine

Throws:

java.lang.IllegalArgumentException - a core could not be constructed due to invalid data