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. State machines support 2 modes for handling inner events: normal mode and priority mode. In normal mode events generated by transitions of the machine cores are simply added to the main event queue behind already enqueued requests. In priority mode these internal events are handled before any already enqueued event. From the internal events the oldest ones are always processed first. A new external event is only processed once all internal events have been handled and no new internal events have been created. The mode can be set using setPrioritiseInternalEvents(boolean).

Since:

awaeUtils 0.0.3

Version:

1.3 (0.0.5)

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
StateMachineBuilder	setPrioritiseInternalEvents(boolean prioritise) Set if internal events should get priority over all other events.

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

setPrioritiseInternalEvents

public StateMachineBuilder setPrioritiseInternalEvents(boolean prioritise)

Set if internal events should get priority over all other events. if set to true internal events generated by an event are processed immediately before processing the next external event. If the processing of internal events yields more internal events they are queued in order of appearance (i.e. the oldest internal event is always processed first)

Parameters:

prioritise -

Returns:

the builder itself

Since:

1.3

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