org.springframework.statemachine.config.configurers

Class DefaultConfigurationConfigurer<S,E>

java.lang.Object

org.springframework.statemachine.config.common.annotation.AnnotationConfigurerAdapter<ConfigurationData<S,E>,StateMachineConfigurationConfigurer<S,E>,StateMachineConfigurationBuilder<S,E>>

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

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

AnnotationConfigurer<ConfigurationData<S,E>,StateMachineConfigurationBuilder<S,E>>, AnnotationConfigurerBuilder<StateMachineConfigurationConfigurer<S,E>>, ConfigurationConfigurer<S,E>

public class DefaultConfigurationConfigurer<S,E>
extends AnnotationConfigurerAdapter<ConfigurationData<S,E>,StateMachineConfigurationConfigurer<S,E>,StateMachineConfigurationBuilder<S,E>>
implements ConfigurationConfigurer<S,E>

Default implementation of a ConfigurationConfigurer.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationConfigurer()

Method Summary

Modifier and Type	Method and Description
ConfigurationConfigurer<S,E>	autoStartup(boolean autoStart) Specify if state machine should be started automatically.
ConfigurationConfigurer<S,E>	beanFactory(org.springframework.beans.factory.BeanFactory beanFactory) Specify a BeanFactory.
void	configure(StateMachineConfigurationBuilder<S,E> builder) Configure the AnnotationBuilder by setting the necessary properties on the AnnotationBuilder.
ConfigurationConfigurer<S,E>	listener(StateMachineListener<S,E> listener) Specify a StateMachineListener to be registered with a state machine.
ConfigurationConfigurer<S,E>	machineId(java.lang.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, java.util.concurrent.TimeUnit unit) Specify a timeout used with StateDoActionPolicy.
ConfigurationConfigurer<S,E>	transitionConflictPolicy(TransitionConflictPolicy transitionConflightPolicy) Specify a TransitionConflictPolicy.

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 Detail

DefaultConfigurationConfigurer

public DefaultConfigurationConfigurer()

Method Detail

configure

public void configure(StateMachineConfigurationBuilder<S,E> builder)
               throws java.lang.Exception

Description copied from interface: AnnotationConfigurer

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

Specified by:

configure in interface AnnotationConfigurer<ConfigurationData<S,E>,StateMachineConfigurationBuilder<S,E>>

Overrides:

configure in class AnnotationConfigurerAdapter<ConfigurationData<S,E>,StateMachineConfigurationConfigurer<S,E>,StateMachineConfigurationBuilder<S,E>>

Parameters:

builder - the builder

Throws:

java.lang.Exception - if error occurred

machineId

public ConfigurationConfigurer<S,E> machineId(java.lang.String id)

Description copied from interface: ConfigurationConfigurer

Specify a machine identifier.

Specified by:

machineId in interface ConfigurationConfigurer<S,E>

Parameters:

id - the machine identifier

Returns:

configurer for chaining

See Also:

Region.getId()

beanFactory

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

Description copied from interface: ConfigurationConfigurer

Specify a BeanFactory.

Specified by:

beanFactory in interface ConfigurationConfigurer<S,E>

Parameters:

beanFactory - the bean factory

Returns:

configurer for chaining

autoStartup

public ConfigurationConfigurer<S,E> autoStartup(boolean autoStart)

Description copied from interface: ConfigurationConfigurer

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

Specified by:

autoStartup in interface ConfigurationConfigurer<S,E>

Parameters:

autoStart - the autoStartup flag

Returns:

configurer for chaining

listener

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

Description copied from interface: ConfigurationConfigurer

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

Specified by:

listener in interface ConfigurationConfigurer<S,E>

Parameters:

listener - the listener to register

Returns:

the configuration configurer

transitionConflictPolicy

public ConfigurationConfigurer<S,E> transitionConflictPolicy(TransitionConflictPolicy transitionConflightPolicy)

Description copied from interface: ConfigurationConfigurer

Specify a TransitionConflictPolicy. Default to TransitionConflictPolicy.CHILD.

Specified by:

transitionConflictPolicy in interface ConfigurationConfigurer<S,E>

Parameters:

transitionConflightPolicy - the transition conflict policy

Returns:

the configuration configurer

stateDoActionPolicy

public ConfigurationConfigurer<S,E> stateDoActionPolicy(StateDoActionPolicy stateDoActionPolicy)

Description copied from interface: ConfigurationConfigurer

Specify a StateDoActionPolicy. Defaults to StateDoActionPolicy.IMMEDIATE_CANCEL.

Specified by:

stateDoActionPolicy in interface ConfigurationConfigurer<S,E>

Parameters:

stateDoActionPolicy - the state do action policy

Returns:

the configuration configurer

stateDoActionPolicyTimeout

public ConfigurationConfigurer<S,E> stateDoActionPolicyTimeout(long timeout,
                                                               java.util.concurrent.TimeUnit unit)

Description copied from interface: ConfigurationConfigurer

Specify a timeout used with StateDoActionPolicy.

Specified by:

stateDoActionPolicyTimeout in interface ConfigurationConfigurer<S,E>

Parameters:

timeout - the timeout

unit - the time unit

Returns:

the configuration configurer

regionExecutionPolicy

public ConfigurationConfigurer<S,E> regionExecutionPolicy(RegionExecutionPolicy regionExecutionPolicy)

Description copied from interface: ConfigurationConfigurer

Specify a RegionExecutionPolicy. Default to RegionExecutionPolicy.SEQUENTIAL.

Specified by:

regionExecutionPolicy in interface ConfigurationConfigurer<S,E>

Parameters:

regionExecutionPolicy - the region execution policy

Returns:

the configuration configurer