org.springframework.statemachine.test

Class StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder

java.lang.Object

org.springframework.statemachine.test.StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder

Enclosing class:

StateMachineTestPlanBuilder<S,E>

public class StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder
extends java.lang.Object

Builder for individual plan steps.

Constructor Summary

Constructors

Constructor and Description
StateMachineTestPlanStepBuilder()

Method Summary

Modifier and Type	Method and Description
StateMachineTestPlanBuilder<S,E>	and() Add a new step and return StateMachineTestPlanBuilder for chaining.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectEventNotAccepted(int count) Expect event not accepter happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectExtendedStateChanged(int count) Expect state machine extended state variables changing count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectState(S state) Expect a state S.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectStateChanged(int count) Expect state changed happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectStateEntered(int count) Expect state enter happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectStateEntered(S... states) Expect states entered in order given.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectStateExited(int count) Expect state exit happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectStateExited(S... states) Expect states exited in order given.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectStateMachineStarted(int count) Expect state machine start happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectStateMachineStopped(int count) Expect state machine stop happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectStates(S... states) Expect a states S.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectTransition(int count) Expect transition happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectTransitionEnded(int count) Expect transition end happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectTransitionStarted(int count) Expect transition start happening count times.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectVariable(java.lang.Object key) Expect variable to exist in extended state variables.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectVariable(java.lang.Object key, java.lang.Object value) Expect variable to exist in extended state variables and match with the value.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	expectVariableWith(org.hamcrest.Matcher<java.util.Map<? extends java.lang.Object,?>> matcher) Expect variable map with hamcrest Matcher.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	sendEvent(E event) Send an event E.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	sendEvent(E event, boolean sendToAll) Send an event E.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	sendEvent(E event, boolean sendToAll, boolean sendParallel) Send an event E.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	sendEvent(E event, java.lang.Object machineId) Send an event E into a state machine identified by machineId.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	sendEvent(org.springframework.messaging.Message<E> event) Send a message Message<E>.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	sendEvent(org.springframework.messaging.Message<E> event, boolean sendToAll) Send a message Message<E>.
StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder	sendEvent(org.springframework.messaging.Message<E> event, java.lang.Object machineId) Send a message Message<E> into a state machine identified by machineId.

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachineTestPlanStepBuilder

public StateMachineTestPlanStepBuilder()

Method Detail

expectState

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectState(S state)

Expect a state S.

Parameters:

state - the state

Returns:

the state machine test plan step builder

expectStates

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectStates(S... states)

Expect a states S.

Parameters:

states - the states

Returns:

the state machine test plan step builder

sendEvent

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder sendEvent(E event)

Send an event E. In case multiple state machines exists, a random one will be chosen to send this event. Multiple events can be defined which are then send in defined order.

Parameters:

event - the event

Returns:

the state machine test plan step builder

sendEvent

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder sendEvent(E event,
                                                                             boolean sendToAll)

Send an event E. If sendToAll is set to TRUE event will be send to all existing machines. Multiple events can be defined which are then send in defined order.

Parameters:

event - the event

sendToAll - send to all machines

Returns:

the state machine test plan step builder

sendEvent

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder sendEvent(E event,
                                                                             boolean sendToAll,
                                                                             boolean sendParallel)

Send an event E. If sendToAll is set to TRUE event will be send to all existing machines. If sendPalallel is set to TRUE event to all machines will be send by parallel threads. Multiple events can be defined which are then send in defined order.

Parameters:

event - the event

sendToAll - send to all machines

sendParallel - send event parallel

Returns:

the state machine test plan step builder

sendEvent

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder sendEvent(E event,
                                                                             java.lang.Object machineId)

Send an event E into a state machine identified by machineId. Multiple events can be defined which are then send in defined order.

Parameters:

event - the event

machineId - the machine identifier for sending event

Returns:

the state machine test plan step builder

sendEvent

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder sendEvent(org.springframework.messaging.Message<E> event)

Send a message Message<E>. In case multiple state machines exists, a random one will be chosen to send this event. Multiple events can be defined which are then send in defined order.

Parameters:

event - the event

Returns:

the state machine test plan step builder

sendEvent

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder sendEvent(org.springframework.messaging.Message<E> event,
                                                                             boolean sendToAll)

Send a message Message<E>. If sendToAll is set to TRUE event will be send to all existing machines.Multiple events can be defined which are then send in defined order.

Parameters:

event - the event

sendToAll - send to all machines

Returns:

the state machine test plan step builder

sendEvent

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder sendEvent(org.springframework.messaging.Message<E> event,
                                                                             java.lang.Object machineId)

Send a message Message<E> into a state machine identified by machineId. Multiple events can be defined which are then send in defined order.

Parameters:

event - the event

machineId - the machine identifier for sending event

Returns:

the state machine test plan step builder

expectVariable

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectVariable(java.lang.Object key)

Expect variable to exist in extended state variables.

Parameters:

key - the key

Returns:

the state machine test plan step builder

expectVariableWith

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectVariableWith(org.hamcrest.Matcher<java.util.Map<? extends java.lang.Object,?>> matcher)

Expect variable map with hamcrest Matcher.

Parameters:

matcher - the matcher

Returns:

the state machine test plan step builder

expectVariable

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectVariable(java.lang.Object key,
                                                                                  java.lang.Object value)

Expect variable to exist in extended state variables and match with the value.

Parameters:

key - the key

value - the value

Returns:

the state machine test plan step builder

expectStateChanged

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectStateChanged(int count)

Expect state changed happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectStateEntered

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectStateEntered(S... states)

Expect states entered in order given.

Parameters:

states - the states entered

Returns:

the state machine test plan step builder

expectStateExited

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectStateExited(S... states)

Expect states exited in order given.

Parameters:

states - the states exited

Returns:

the state machine test plan step builder

expectStateEntered

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectStateEntered(int count)

Expect state enter happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectStateExited

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectStateExited(int count)

Expect state exit happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectEventNotAccepted

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectEventNotAccepted(int count)

Expect event not accepter happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectTransition

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectTransition(int count)

Expect transition happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectTransitionStarted

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectTransitionStarted(int count)

Expect transition start happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectTransitionEnded

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectTransitionEnded(int count)

Expect transition end happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectStateMachineStarted

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectStateMachineStarted(int count)

Expect state machine start happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectStateMachineStopped

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectStateMachineStopped(int count)

Expect state machine stop happening count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

expectExtendedStateChanged

public StateMachineTestPlanBuilder.StateMachineTestPlanStepBuilder expectExtendedStateChanged(int count)

Expect state machine extended state variables changing count times.

Parameters:

count - the count

Returns:

the state machine test plan step builder

and

public StateMachineTestPlanBuilder<S,E> and()

Add a new step and return StateMachineTestPlanBuilder for chaining.

Returns:

the state machine test plan builder for chaining