Package org.springframework.statemachine.config.configurers

Class DefaultStateConfigurer<S,E>

java.lang.Object

org.springframework.statemachine.config.common.annotation.AnnotationConfigurerAdapter<StatesData<S,E>,StateMachineStateConfigurer<S,E>,StateMachineStateBuilder<S,E>>

org.springframework.statemachine.config.configurers.DefaultStateConfigurer<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

AnnotationConfigurer<StatesData<S,E>,StateMachineStateBuilder<S,E>>, AnnotationConfigurerBuilder<StateMachineStateConfigurer<S,E>>, StateConfigurer<S,E>

public class DefaultStateConfigurer<S,E>
extends AnnotationConfigurerAdapter<StatesData<S,E>,StateMachineStateConfigurer<S,E>,StateMachineStateBuilder<S,E>>
implements StateConfigurer<S,E>

Default implementation of a StateConfigurer.

Author:

Janne Valkealahti

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.statemachine.config.configurers.StateConfigurer

StateConfigurer.History

Constructor Summary

Constructors

Constructor	Description
DefaultStateConfigurer()

Method Summary

Modifier and Type	Method	Description
StateConfigurer<S,E>	choice(S choice)	Specify a state S to be choice pseudo state.
void	configure(StateMachineStateBuilder<S,E> builder)	Configure the AnnotationBuilder by setting the necessary properties on the AnnotationBuilder.
StateConfigurer<S,E>	end(S end)	Specify a state S to be end state.
StateConfigurer<S,E>	entry(S entry)	Specify a state S to be entrypoint pseudo state.
StateConfigurer<S,E>	exit(S exit)	Specify a state S to be exitpoint pseudo state.
StateConfigurer<S,E>	fork(S fork)	Specify a state S to be fork pseudo state.
StateConfigurer<S,E>	history(S history, StateConfigurer.History type)	Specify a state S to be history pseudo state.
StateConfigurer<S,E>	initial(S initial)	Specify a initial state S.
StateConfigurer<S,E>	initial(S initial, Action<S,E> action)	Specify a initial state S with an Action to be executed with it.
StateConfigurer<S,E>	join(S join)	Specify a state S to be join pseudo state.
StateConfigurer<S,E>	junction(S junction)	Specify a state S to be junction pseudo state.
StateConfigurer<S,E>	parent(S state)	Specify a states configured by this configurer instance to be substates of state S.
StateConfigurer<S,E>	region(String id)	Specify a region for these states configured by this configurer instance.
StateConfigurer<S,E>	state(S state)	Specify a state S.
StateConfigurer<S,E>	state(S state, E... deferred)	Specify a state S with a deferred events E.
StateConfigurer<S,E>	state(S state, Collection<? extends Action<S,E>> stateActions)	Specify a state S with state Actions.
StateConfigurer<S,E>	state(S state, Collection<? extends Action<S,E>> entryActions, Collection<? extends Action<S,E>> exitActions)	Specify a state S with entry and exit Actions.
StateConfigurer<S,E>	state(S state, Action<S,E> stateAction)	Specify a state S with state Action.
StateConfigurer<S,E>	state(S state, Action<S,E> entryAction, Action<S,E> exitAction)	Specify a state S with entry and exit Action.
StateConfigurer<S,E>	state(S state, StateMachineFactory<S,E> stateMachineFactory)	Specify a state S and its relation with a given machine as substate machine factory.
StateConfigurer<S,E>	state(S state, StateMachine<S,E> stateMachine)	Specify a state S and its relation with a given machine as substate machine.
StateConfigurer<S,E>	stateDo(S state, Action<S,E> action)	Specify a state S with state behaviour Action.
StateConfigurer<S,E>	stateDo(S state, Action<S,E> action, Action<S,E> error)	Specify a state S with state behaviour Action and error Action callback.
StateConfigurer<S,E>	stateDoFunction(S state, Function<StateContext<S,E>,reactor.core.publisher.Mono<Void>> stateAction)	Specify a state S with state behaviour Function.
StateConfigurer<S,E>	stateEntry(S state, Action<S,E> action)	Specify a state S with state entry Action.
StateConfigurer<S,E>	stateEntry(S state, Action<S,E> action, Action<S,E> error)	Specify a state S with state entry Action and error Action callback.
StateConfigurer<S,E>	stateEntryFunction(S state, Function<StateContext<S,E>,reactor.core.publisher.Mono<Void>> action)	Specify a state S with state entry Function.
StateConfigurer<S,E>	stateExit(S state, Action<S,E> action)	Specify a state S with state exit Action.
StateConfigurer<S,E>	stateExit(S state, Action<S,E> action, Action<S,E> error)	Specify a state S with state exit Action and error Action callback.
StateConfigurer<S,E>	stateExitFunction(S state, Function<StateContext<S,E>,reactor.core.publisher.Mono<Void>> action)	Specify a state S with state exit Function.
StateConfigurer<S,E>	states(Set<S> states)	Specify a states S.

Methods inherited from class org.springframework.statemachine.config.common.annotation.AnnotationConfigurerAdapter

addObjectPostProcessor, and, getBuilder, init, isAssignable, setBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.statemachine.config.common.annotation.AnnotationConfigurerBuilder

and

Constructor Details

DefaultStateConfigurer

public DefaultStateConfigurer()

Method Details

configure

public void configure(StateMachineStateBuilder<S,E> builder)
               throws Exception

Description copied from interface: AnnotationConfigurer

Configure the AnnotationBuilder by setting the necessary properties on the AnnotationBuilder.

Specified by:

configure in interface AnnotationConfigurer<S,E>

Overrides:

configure in class AnnotationConfigurerAdapter<StatesData<S,E>,StateMachineStateConfigurer<S,E>,StateMachineStateBuilder<S,E>>

Parameters:

builder - the builder

Throws:

Exception - if error occurred

initial

public StateConfigurer<S,E> initial(S initial)

Description copied from interface: StateConfigurer

Specify a initial state S.

Specified by:

initial in interface StateConfigurer<S,E>

Parameters:

initial - the initial state

Returns:

configurer for chaining

initial

public StateConfigurer<S,E> initial(S initial,
 Action<S,E> action)

Description copied from interface: StateConfigurer

Specify a initial state S with an Action to be executed with it. Action can be i.e. used to init extended variables.

Specified by:

initial in interface StateConfigurer<S,E>

Parameters:

initial - the initial state

action - the action

Returns:

configurer for chaining

parent

public StateConfigurer<S,E> parent(S state)

Description copied from interface: StateConfigurer

Specify a states configured by this configurer instance to be substates of state S.

Specified by:

parent in interface StateConfigurer<S,E>

Parameters:

state - the parent state

Returns:

configurer for chaining

region

public StateConfigurer<S,E> region(String id)

Description copied from interface: StateConfigurer

Specify a region for these states configured by this configurer instance.

Specified by:

region in interface StateConfigurer<S,E>

Parameters:

id - the region id

Returns:

configurer for chaining

end

public StateConfigurer<S,E> end(S end)

Description copied from interface: StateConfigurer

Specify a state S to be end state. This method can be called for each state to be marked as end state.

Specified by:

end in interface StateConfigurer<S,E>

Parameters:

end - the end state

Returns:

configurer for chaining

state

public StateConfigurer<S,E> state(S state)

Description copied from interface: StateConfigurer

Specify a state S.

Specified by:

state in interface StateConfigurer<S,E>

Parameters:

state - the state

Returns:

configurer for chaining

state

public StateConfigurer<S,E> state(S state,
 StateMachine<S,E> stateMachine)

Description copied from interface: StateConfigurer

Specify a state S and its relation with a given machine as substate machine.

Specified by:

state in interface StateConfigurer<S,E>

Parameters:

state - the state

stateMachine - the submachine

Returns:

configurer for chaining

state

public StateConfigurer<S,E> state(S state,
 StateMachineFactory<S,E> stateMachineFactory)

Description copied from interface: StateConfigurer

Specify a state S and its relation with a given machine as substate machine factory.

Specified by:

state in interface StateConfigurer<S,E>

Parameters:

state - the state

stateMachineFactory - the submachine factory

Returns:

configurer for chaining

state

public StateConfigurer<S,E> state(S state,
 Collection<? extends Action<S,E>> stateActions)

Description copied from interface: StateConfigurer

Specify a state S with state Actions.

Specified by:

state in interface StateConfigurer<S,E>

Parameters:

state - the state

stateActions - the state actions

Returns:

configurer for chaining

state

public StateConfigurer<S,E> state(S state,
 Action<S,E> stateAction)

Description copied from interface: StateConfigurer

Specify a state S with state Action.

Specified by:

state in interface StateConfigurer<S,E>

Parameters:

state - the state

stateAction - the state action

Returns:

configurer for chaining

stateDo

public StateConfigurer<S,E> stateDo(S state,
 Action<S,E> action)

Description copied from interface: StateConfigurer

Specify a state S with state behaviour Action. Currently synonym for StateConfigurer.state(Object, Action).

Specified by:

stateDo in interface StateConfigurer<S,E>

Parameters:

state - the state

action - the state action

Returns:

configurer for chaining

See Also:

• StateConfigurer.state(Object, Action)

stateDoFunction

public StateConfigurer<S,E> stateDoFunction(S state,
 Function<StateContext<S,E>,reactor.core.publisher.Mono<Void>> stateAction)

Description copied from interface: StateConfigurer

Specify a state S with state behaviour Function.

Specified by:

stateDoFunction in interface StateConfigurer<S,E>

Parameters:

state - the state

stateAction - the state action

Returns:

configurer for chaining

stateEntryFunction

public StateConfigurer<S,E> stateEntryFunction(S state,
 Function<StateContext<S,E>,reactor.core.publisher.Mono<Void>> action)

Description copied from interface: StateConfigurer

Specify a state S with state entry Function.

Specified by:

stateEntryFunction in interface StateConfigurer<S,E>

Parameters:

state - the state

action - the state action

Returns:

configurer for chaining

stateExitFunction

public StateConfigurer<S,E> stateExitFunction(S state,
 Function<StateContext<S,E>,reactor.core.publisher.Mono<Void>> action)

Description copied from interface: StateConfigurer

Specify a state S with state exit Function.

Specified by:

stateExitFunction in interface StateConfigurer<S,E>

Parameters:

state - the state

action - the state action

Returns:

configurer for chaining

stateDo

public StateConfigurer<S,E> stateDo(S state,
 Action<S,E> action,
 Action<S,E> error)

Description copied from interface: StateConfigurer

Specify a state S with state behaviour Action and error Action callback.

Specified by:

stateDo in interface StateConfigurer<S,E>

Parameters:

state - the state

action - the state action

error - action that will be called if any unexpected exception is thrown by the action.

Returns:

configurer for chaining

state

public StateConfigurer<S,E> state(S state,
 Collection<? extends Action<S,E>> entryActions,
 Collection<? extends Action<S,E>> exitActions)

Description copied from interface: StateConfigurer

Specify a state S with entry and exit Actions.

Specified by:

state in interface StateConfigurer<S,E>

Parameters:

state - the state

entryActions - the state entry actions

exitActions - the state exit actions

Returns:

configurer for chaining

state

public StateConfigurer<S,E> state(S state,
 Action<S,E> entryAction,
 Action<S,E> exitAction)

Description copied from interface: StateConfigurer

Specify a state S with entry and exit Action.

Specified by:

state in interface StateConfigurer<S,E>

Parameters:

state - the state

entryAction - the state entry action

exitAction - the state exit action

Returns:

configurer for chaining

stateEntry

public StateConfigurer<S,E> stateEntry(S state,
 Action<S,E> action)

Description copied from interface: StateConfigurer

Specify a state S with state entry Action. Currently synonym for StateConfigurer.state(Object, Action, Action) with no exit action.

Specified by:

stateEntry in interface StateConfigurer<S,E>

Parameters:

state - the state

action - the state entry action

Returns:

configurer for chaining

See Also:

• StateConfigurer.state(Object, Action, Action)

stateEntry

public StateConfigurer<S,E> stateEntry(S state,
 Action<S,E> action,
 Action<S,E> error)

Description copied from interface: StateConfigurer

Specify a state S with state entry Action and error Action callback. Currently synonym for StateConfigurer.state(Object, Action, Action) with no exit action.

Specified by:

stateEntry in interface StateConfigurer<S,E>

Parameters:

state - the state

action - the state entry action

error - action that will be called if any unexpected exception is thrown by the action.

Returns:

configurer for chaining

See Also:

• StateConfigurer.state(Object, Action, Action)

stateExit

public StateConfigurer<S,E> stateExit(S state,
 Action<S,E> action)

Description copied from interface: StateConfigurer

Specify a state S with state exit Action. Currently synonym for StateConfigurer.state(Object, Action, Action) with no entry action.

Specified by:

stateExit in interface StateConfigurer<S,E>

Parameters:

state - the state

action - the state exit action

Returns:

configurer for chaining

See Also:

• StateConfigurer.state(Object, Action, Action)

stateExit

public StateConfigurer<S,E> stateExit(S state,
 Action<S,E> action,
 Action<S,E> error)

Description copied from interface: StateConfigurer

Specify a state S with state exit Action and error Action callback. Currently synonym for StateConfigurer.state(Object, Action, Action) with no entry action.

Specified by:

stateExit in interface StateConfigurer<S,E>

Parameters:

state - the state

action - the state entry action

error - action that will be called if any unexpected exception is thrown by the action.

Returns:

configurer for chaining

See Also:

• StateConfigurer.state(Object, Action, Action)

state

public StateConfigurer<S,E> state(S state,
 E... deferred)

Description copied from interface: StateConfigurer

Specify a state S with a deferred events E.

Specified by:

state in interface StateConfigurer<S,E>

Parameters:

state - the state

deferred - the deferred events

Returns:

configurer for chaining

states

public StateConfigurer<S,E> states(Set<S> states)

Description copied from interface: StateConfigurer

Specify a states S.

Specified by:

states in interface StateConfigurer<S,E>

Parameters:

states - the states

Returns:

configurer for chaining

choice

public StateConfigurer<S,E> choice(S choice)

Description copied from interface: StateConfigurer

Specify a state S to be choice pseudo state.

Specified by:

choice in interface StateConfigurer<S,E>

Parameters:

choice - the choice pseudo state

Returns:

configurer for chaining

junction

public StateConfigurer<S,E> junction(S junction)

Description copied from interface: StateConfigurer

Specify a state S to be junction pseudo state.

Specified by:

junction in interface StateConfigurer<S,E>

Parameters:

junction - the junction pseudo state

Returns:

configurer for chaining

fork

public StateConfigurer<S,E> fork(S fork)

Description copied from interface: StateConfigurer

Specify a state S to be fork pseudo state.

Specified by:

fork in interface StateConfigurer<S,E>

Parameters:

fork - the fork pseudo state

Returns:

configurer for chaining

join

public StateConfigurer<S,E> join(S join)

Description copied from interface: StateConfigurer

Specify a state S to be join pseudo state.

Specified by:

join in interface StateConfigurer<S,E>

Parameters:

join - the join pseudo state

Returns:

configurer for chaining

history

public StateConfigurer<S,E> history(S history,
 StateConfigurer.History type)

Description copied from interface: StateConfigurer

Specify a state S to be history pseudo state.

Specified by:

history in interface StateConfigurer<S,E>

Parameters:

history - the history pseudo state

type - the history pseudo state type

Returns:

configurer for chaining

entry

public StateConfigurer<S,E> entry(S entry)

Description copied from interface: StateConfigurer

Specify a state S to be entrypoint pseudo state.

Specified by:

entry in interface StateConfigurer<S,E>

Parameters:

entry - the entrypoint pseudo state

Returns:

configurer for chaining

exit

public StateConfigurer<S,E> exit(S exit)

Description copied from interface: StateConfigurer

Specify a state S to be exitpoint pseudo state.

Specified by:

exit in interface StateConfigurer<S,E>

Parameters:

exit - the exitpoint pseudo state

Returns:

configurer for chaining