Package org.springframework.statemachine.config.configurers

Interface ConfigurationConfigurer<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Superinterfaces:

AnnotationConfigurerBuilder<StateMachineConfigurationConfigurer<S,E>>

All Known Implementing Classes:

DefaultConfigurationConfigurer

public interface ConfigurationConfigurer<S,E>
extends AnnotationConfigurerBuilder<StateMachineConfigurationConfigurer<S,E>>

Base ConfigConfigurer interface for configuring generic config.

Author:

Janne Valkealahti

Method Summary

Modifier and Type	Method	Description
ConfigurationConfigurer<S,E>	autoStartup(boolean autoStartup)	Specify if state machine should be started automatically.
ConfigurationConfigurer<S,E>	beanFactory(org.springframework.beans.factory.BeanFactory beanFactory)	Specify a BeanFactory.
ConfigurationConfigurer<S,E>	listener(StateMachineListener<S,E> listener)	Specify a StateMachineListener to be registered with a state machine.
ConfigurationConfigurer<S,E>	machineId(String id)	Specify a machine identifier.
ConfigurationConfigurer<S,E>	regionExecutionPolicy(RegionExecutionPolicy regionExecutionPolicy)	Specify a RegionExecutionPolicy.
ConfigurationConfigurer<S,E>	stateDoActionPolicy(StateDoActionPolicy stateDoActionPolicy)	Specify a StateDoActionPolicy.
ConfigurationConfigurer<S,E>	stateDoActionPolicyTimeout(long timeout, TimeUnit unit)	Specify a timeout used with StateDoActionPolicy.
ConfigurationConfigurer<S,E>	transitionConflictPolicy(TransitionConflictPolicy transitionConflictPolicy)	Specify a TransitionConflictPolicy.

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

and

Method Details

machineId

ConfigurationConfigurer<S,E> machineId(String id)

Specify a machine identifier.

Parameters:

id - the machine identifier

Returns:

configurer for chaining

See Also:

• Region.getId()

beanFactory

ConfigurationConfigurer<S,E> beanFactory(org.springframework.beans.factory.BeanFactory beanFactory)

Specify a BeanFactory.

Parameters:

beanFactory - the bean factory

Returns:

configurer for chaining

autoStartup

ConfigurationConfigurer<S,E> autoStartup(boolean autoStartup)

Specify if state machine should be started automatically. On default state machine is not started automatically.

Parameters:

autoStartup - the autoStartup flag

Returns:

configurer for chaining

listener

ConfigurationConfigurer<S,E> listener(StateMachineListener<S,E> listener)

Specify a StateMachineListener to be registered with a state machine. This method can be called multiple times to register multiple listeners.

Parameters:

listener - the listener to register

Returns:

the configuration configurer

transitionConflictPolicy

ConfigurationConfigurer<S,E> transitionConflictPolicy(TransitionConflictPolicy transitionConflictPolicy)

Specify a TransitionConflictPolicy. Default to TransitionConflictPolicy.CHILD.

Parameters:

transitionConflictPolicy - the transition conflict policy

Returns:

the configuration configurer

stateDoActionPolicy

ConfigurationConfigurer<S,E> stateDoActionPolicy(StateDoActionPolicy stateDoActionPolicy)

Specify a StateDoActionPolicy. Defaults to StateDoActionPolicy.IMMEDIATE_CANCEL.

Parameters:

stateDoActionPolicy - the state do action policy

Returns:

the configuration configurer

stateDoActionPolicyTimeout

ConfigurationConfigurer<S,E> stateDoActionPolicyTimeout(long timeout,
 TimeUnit unit)

Specify a timeout used with StateDoActionPolicy.

Parameters:

timeout - the timeout

unit - the time unit

Returns:

the configuration configurer

regionExecutionPolicy

ConfigurationConfigurer<S,E> regionExecutionPolicy(RegionExecutionPolicy regionExecutionPolicy)

Specify a RegionExecutionPolicy. Default to RegionExecutionPolicy.SEQUENTIAL.

Parameters:

regionExecutionPolicy - the region execution policy

Returns:

the configuration configurer