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<TransitionsData<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<TransitionsData<S,E>>

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

AnnotationBuilder for TransitionsData.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
StateMachineTransitionBuilder() Instantiates a new state machine transition builder.
StateMachineTransitionBuilder(ObjectPostProcessor<java.lang.Object> objectPostProcessor) Instantiates a new state machine transition builder.
StateMachineTransitionBuilder(ObjectPostProcessor<java.lang.Object> objectPostProcessor, boolean allowConfigurersOfSameType) Instantiates a new state machine transition builder.

Method Summary

Modifier and Type	Method and Description
void	addChoice(S source, java.util.List<ChoiceData<S,E>> choices) Adds the choice.
void	addDefaultHistory(S source, S target) Adds the default history.
void	addEntry(S source, S target) Adds the entry.
void	addExit(S source, S target) Adds the exit.
void	addFork(S source, java.util.List<S> targets) Adds the fork.
void	addJoin(S target, java.util.List<S> sources) Adds the join.
void	addJunction(S source, java.util.List<JunctionData<S,E>> junctions) Adds the junction.
void	addTransition(S source, S target, S state, E event, java.lang.Long period, java.lang.Integer count, java.util.Collection<Action<S,E>> actions, Guard<S,E> guard, TransitionKind kind, SecurityRule securityRule, java.lang.String name) Adds the transition.
protected TransitionsData<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.
EntryTransitionConfigurer<S,E>	withEntry() Gets a configurer for transition from an entrypoint pseudostate.
ExitTransitionConfigurer<S,E>	withExit() Gets a configurer for transition from an exitpoint pseudostate.
ExternalTransitionConfigurer<S,E>	withExternal() Gets a configurer for external transition.
ForkTransitionConfigurer<S,E>	withFork() Gets a configurer for transition from a fork pseudostate.
HistoryTransitionConfigurer<S,E>	withHistory() Gets a configurer for default history transition.
InternalTransitionConfigurer<S,E>	withInternal() Gets a configurer for internal transition.
JoinTransitionConfigurer<S,E>	withJoin() Gets a configurer for transition from a join pseudostate.
JunctionTransitionConfigurer<S,E>	withJunction() Gets a configurer for transition from a junction 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()

Instantiates a new state machine transition builder.

StateMachineTransitionBuilder

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

Instantiates a new state machine transition builder.

Parameters:

objectPostProcessor - the object post processor

allowConfigurersOfSameType - the allow configurers of same type

StateMachineTransitionBuilder

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

Instantiates a new state machine transition builder.

Parameters:

objectPostProcessor - the object post processor

Method Detail

performBuild

protected TransitionsData<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<TransitionsData<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

withJunction

public JunctionTransitionConfigurer<S,E> withJunction()
                                               throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for transition from a junction pseudostate.

Specified by:

withJunction in interface StateMachineTransitionConfigurer<S,E>

Returns:

JunctionTransitionConfigurer 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

withEntry

public EntryTransitionConfigurer<S,E> withEntry()
                                         throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for transition from an entrypoint pseudostate.

Specified by:

withEntry in interface StateMachineTransitionConfigurer<S,E>

Returns:

EntryTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

withExit

public ExitTransitionConfigurer<S,E> withExit()
                                       throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for transition from an exitpoint pseudostate.

Specified by:

withExit in interface StateMachineTransitionConfigurer<S,E>

Returns:

ExitTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

withHistory

public HistoryTransitionConfigurer<S,E> withHistory()
                                             throws java.lang.Exception

Description copied from interface: StateMachineTransitionConfigurer

Gets a configurer for default history transition.

Specified by:

withHistory in interface StateMachineTransitionConfigurer<S,E>

Returns:

HistoryTransitionConfigurer for chaining

Throws:

java.lang.Exception - if configuration error happens

addTransition

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

Adds the transition.

Parameters:

source - the source

target - the target

state - the state

event - the event

period - the period

count - the count

actions - the actions

guard - the guard

kind - the kind

securityRule - the security rule

addChoice

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

Adds the choice.

Parameters:

source - the source

choices - the choices

addJunction

public void addJunction(S source,
                        java.util.List<JunctionData<S,E>> junctions)

Adds the junction.

Parameters:

source - the source

junctions - the junctions

addEntry

public void addEntry(S source,
                     S target)

Adds the entry.

Parameters:

source - the source

target - the target

addExit

public void addExit(S source,
                    S target)

Adds the exit.

Parameters:

source - the source

target - the target

addFork

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

Adds the fork.

Parameters:

source - the source

targets - the targets

addJoin

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

Adds the join.

Parameters:

target - the target

sources - the sources

addDefaultHistory

public void addDefaultHistory(S source,
                              S target)

Adds the default history.

Parameters:

source - the source

target - the target