org.springframework.statemachine.config.builders

Class StateMachineTransitionBuilder<S,E>

java.lang.Object

org.springframework.statemachine.config.common.annotation.AbstractAnnotationBuilder<O>

org.springframework.statemachine.config.common.annotation.AbstractConfiguredAnnotationBuilder<StateMachineTransitions<S,E>,StateMachineTransitionConfigurer<S,E>,StateMachineTransitionBuilder<S,E>>

org.springframework.statemachine.config.builders.StateMachineTransitionBuilder<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

StateMachineTransitionConfigurer<S,E>, AnnotationBuilder<StateMachineTransitions<S,E>>

public class StateMachineTransitionBuilder<S,E>
extends AbstractConfiguredAnnotationBuilder<StateMachineTransitions<S,E>,StateMachineTransitionConfigurer<S,E>,StateMachineTransitionBuilder<S,E>>
implements StateMachineTransitionConfigurer<S,E>

AnnotationBuilder for StateMachineTransitions.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
StateMachineTransitionBuilder()
StateMachineTransitionBuilder(ObjectPostProcessor<java.lang.Object> objectPostProcessor)
StateMachineTransitionBuilder(ObjectPostProcessor<java.lang.Object> objectPostProcessor, boolean allowConfigurersOfSameType)

Method Summary

Modifier and Type	Method and Description
void	add(S source, java.util.List<StateMachineTransitions.ChoiceData<S,E>> choices)
void	add(S source, S target, S state, E event, java.lang.Long period, java.util.Collection<Action<S,E>> actions, Guard<S,E> guard, TransitionKind kind, SecurityRule securityRule)
void	addFork(S source, java.util.List<S> targets)
void	addJoin(S target, java.util.List<S> sources)
protected StateMachineTransitions<S,E>	performBuild() Subclasses must implement this method to build the object that is being returned.
ChoiceTransitionConfigurer<S,E>	withChoice() Gets a configurer for transition from a choice pseudostate.
ExternalTransitionConfigurer<S,E>	withExternal() Gets a configurer for external transition.
ForkTransitionConfigurer<S,E>	withFork() Gets a configurer for transition from a fork pseudostate.
InternalTransitionConfigurer<S,E>	withInternal() Gets a configurer for internal transition.
JoinTransitionConfigurer<S,E>	withJoin() Gets a configurer for transition from a join pseudostate.
LocalTransitionConfigurer<S,E>	withLocal() Gets a configurer for local transition.

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

apply, apply, beforeConfigureMains, beforeConfigurePosts, beforeInit, doBuild, getConfigurer, getConfigurers, getOrApply, getOrBuild, getSharedObject, getSharedObjects, objectPostProcessor, postProcess, removeConfigurer, removeConfigurers, setSharedObject

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

build, getObject

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachineTransitionBuilder

public StateMachineTransitionBuilder()

StateMachineTransitionBuilder

public StateMachineTransitionBuilder(ObjectPostProcessor<java.lang.Object> objectPostProcessor,
                                     boolean allowConfigurersOfSameType)

StateMachineTransitionBuilder

public StateMachineTransitionBuilder(ObjectPostProcessor<java.lang.Object> objectPostProcessor)

Method Detail

performBuild

protected StateMachineTransitions<S,E> performBuild()
                                             throws java.lang.Exception

Description copied from class: AbstractConfiguredAnnotationBuilder

Subclasses must implement this method to build the object that is being returned.

Specified by:

performBuild in class AbstractConfiguredAnnotationBuilder<StateMachineTransitions<S,E>,StateMachineTransitionConfigurer<S,E>,StateMachineTransitionBuilder<S,E>>

Returns:

Object build by this builder

Throws:

java.lang.Exception - if error occurred

withExternal

public ExternalTransitionConfigurer<S,E> withExternal()
                                               throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for external transition.

Specified by:

withExternal in interface StateMachineTransitionConfigurer<S,E>

Returns:

ExternalTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

See Also:

StateMachineTransitionConfigurer.withLocal()

withInternal

public InternalTransitionConfigurer<S,E> withInternal()
                                               throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for internal transition. Internal transition is used when action needs to be executed without causing a state transition. With internal transition source and target state is always a same and it is identical with self-transition in the absence of state entry and exit actions.

Specified by:

withInternal in interface StateMachineTransitionConfigurer<S,E>

Returns:

InternalTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

withLocal

public LocalTransitionConfigurer<S,E> withLocal()
                                         throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for local transition. Local transition doesn’t cause exit and entry to source state if target state is a substate of a source state. Other way around, local transition doesn’t cause exit and entry to target state if target is a superstate of a source state.

Specified by:

withLocal in interface StateMachineTransitionConfigurer<S,E>

Returns:

LocalTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

withChoice

public ChoiceTransitionConfigurer<S,E> withChoice()
                                           throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for transition from a choice pseudostate.

Specified by:

withChoice in interface StateMachineTransitionConfigurer<S,E>

Returns:

ChoiceTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

withFork

public ForkTransitionConfigurer<S,E> withFork()
                                       throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for transition from a fork pseudostate.

Specified by:

withFork in interface StateMachineTransitionConfigurer<S,E>

Returns:

ForkTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

withJoin

public JoinTransitionConfigurer<S,E> withJoin()
                                       throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for transition from a join pseudostate.

Specified by:

withJoin in interface StateMachineTransitionConfigurer<S,E>

Returns:

JoinTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

add

public void add(S source,
                S target,
                S state,
                E event,
                java.lang.Long period,
                java.util.Collection<Action<S,E>> actions,
                Guard<S,E> guard,
                TransitionKind kind,
                SecurityRule securityRule)

add

public void add(S source,
                java.util.List<StateMachineTransitions.ChoiceData<S,E>> choices)

addFork

public void addFork(S source,
                    java.util.List<S> targets)

addJoin

public void addJoin(S target,
                    java.util.List<S> sources)