Package org.springframework.statemachine.config.configurers

Class DefaultExternalTransitionConfigurer<S,E>

java.lang.Object

org.springframework.statemachine.config.common.annotation.AnnotationConfigurerAdapter<TransitionsData<S,E>,StateMachineTransitionConfigurer<S,E>,StateMachineTransitionBuilder<S,E>>

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

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

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

AnnotationConfigurer<TransitionsData<S,E>,StateMachineTransitionBuilder<S,E>>, AnnotationConfigurerBuilder<StateMachineTransitionConfigurer<S,E>>, ExternalTransitionConfigurer<S,E>, TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

public class DefaultExternalTransitionConfigurer<S,E>
extends AbstractTransitionConfigurer<S,E>
implements ExternalTransitionConfigurer<S,E>

Default implementation of a ExternalTransitionConfigurer.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor	Description
DefaultExternalTransitionConfigurer()

Method Summary

Modifier and Type	Method	Description
ExternalTransitionConfigurer<S,E>	action(Action<S,E> action)	Specify Action for this Transition.
ExternalTransitionConfigurer<S,E>	action(Action<S,E> action, Action<S,E> error)	Specify Action for this Transition.
ExternalTransitionConfigurer<S,E>	actionFunction(Function<StateContext<S,E>,reactor.core.publisher.Mono<Void>> action)	Specify Function for this Transition.
void	configure(StateMachineTransitionBuilder<S,E> builder)	Configure the AnnotationBuilder by setting the necessary properties on the AnnotationBuilder.
ExternalTransitionConfigurer<S,E>	event(E event)	Specify event E for this Transition which will be triggered by a event trigger.
ExternalTransitionConfigurer<S,E>	guard(Guard<S,E> guard)	Specify a Guard for this Transition.
ExternalTransitionConfigurer<S,E>	guardExpression(String expression)	Specify a Guard backed by a SpEL expression for this Transition.
ExternalTransitionConfigurer<S,E>	name(String name)	Specify a name for this Transition.
ExternalTransitionConfigurer<S,E>	secured(String expression)	Specify a security expression for this Transition.
ExternalTransitionConfigurer<S,E>	secured(String attributes, SecurityRule.ComparisonType match)	Specify a security attributes for this Transition.
ExternalTransitionConfigurer<S,E>	source(S source)	Specify a source state S for this Transition.
ExternalTransitionConfigurer<S,E>	state(S state)	Specify a state this transition should belong to.
ExternalTransitionConfigurer<S,E>	target(S target)	Specify a target state S for this Transition.
ExternalTransitionConfigurer<S,E>	timer(long period)	Specify that this transition is triggered by a time.
ExternalTransitionConfigurer<S,E>	timerOnce(long period)	Specify that this transition is triggered once by a time after a delay.

Methods inherited from class org.springframework.statemachine.config.configurers.AbstractTransitionConfigurer

addAction, addAction, addActionFunction, getActions, getCount, getEvent, getGuard, getName, getPeriod, getSecurityRule, getSource, getState, getTarget, setCount, setEvent, setGuard, setGuardFunction, setName, setPeriod, setSecurityRule, setSecurityRule, setSource, setState, setTarget

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

DefaultExternalTransitionConfigurer

public DefaultExternalTransitionConfigurer()

Method Details

configure

public void configure(StateMachineTransitionBuilder<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<TransitionsData<S,E>,StateMachineTransitionConfigurer<S,E>,StateMachineTransitionBuilder<S,E>>

Parameters:

builder - the builder

Throws:

Exception - if error occurred

source

public ExternalTransitionConfigurer<S,E> source(S source)

Description copied from interface: TransitionConfigurer

Specify a source state S for this Transition.

Specified by:

source in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

source - the source state S

Returns:

configurer for chaining

target

public ExternalTransitionConfigurer<S,E> target(S target)

Description copied from interface: ExternalTransitionConfigurer

Specify a target state S for this Transition.

Specified by:

target in interface ExternalTransitionConfigurer<S,E>

Parameters:

target - the target state S

Returns:

configurer for chaining

state

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

Description copied from interface: TransitionConfigurer

Specify a state this transition should belong to.

Specified by:

state in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

state - the state S

Returns:

configurer for chaining

event

public ExternalTransitionConfigurer<S,E> event(E event)

Description copied from interface: TransitionConfigurer

Specify event E for this Transition which will be triggered by a event trigger.

Specified by:

event in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

event - the event for transition

Returns:

configurer for chaining

timer

public ExternalTransitionConfigurer<S,E> timer(long period)

Description copied from interface: TransitionConfigurer

Specify that this transition is triggered by a time.

Specified by:

timer in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

period - timer period in millis

Returns:

configurer for chaining

timerOnce

public ExternalTransitionConfigurer<S,E> timerOnce(long period)

Description copied from interface: TransitionConfigurer

Specify that this transition is triggered once by a time after a delay.

Specified by:

timerOnce in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

period - timer period in millis

Returns:

configurer for chaining

action

public ExternalTransitionConfigurer<S,E> action(Action<S,E> action)

Description copied from interface: TransitionConfigurer

Specify Action for this Transition.

Specified by:

action in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

action - the action

Returns:

configurer for chaining

action

public ExternalTransitionConfigurer<S,E> action(Action<S,E> action,
 Action<S,E> error)

Description copied from interface: TransitionConfigurer

Specify Action for this Transition.

Specified by:

action in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

action - the action

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

Returns:

configurer for chaining

actionFunction

public ExternalTransitionConfigurer<S,E> actionFunction(Function<StateContext<S,E>,reactor.core.publisher.Mono<Void>> action)

Description copied from interface: TransitionConfigurer

Specify Function for this Transition.

Specified by:

actionFunction in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

action - the function action

Returns:

configurer for chaining

guard

public ExternalTransitionConfigurer<S,E> guard(Guard<S,E> guard)

Description copied from interface: TransitionConfigurer

Specify a Guard for this Transition.

Specified by:

guard in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

guard - the guard

Returns:

configurer for chaining

guardExpression

public ExternalTransitionConfigurer<S,E> guardExpression(String expression)

Description copied from interface: TransitionConfigurer

Specify a Guard backed by a SpEL expression for this Transition.

Specified by:

guardExpression in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

expression - the SpEL expression

Returns:

configurer for chaining

secured

public ExternalTransitionConfigurer<S,E> secured(String attributes,
 SecurityRule.ComparisonType match)

Description copied from interface: TransitionConfigurer

Specify a security attributes for this Transition.

Specified by:

secured in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

attributes - the security attributes

match - the match type

Returns:

configurer for chaining

secured

public ExternalTransitionConfigurer<S,E> secured(String expression)

Description copied from interface: TransitionConfigurer

Specify a security expression for this Transition.

Specified by:

secured in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

expression - the security expression

Returns:

configurer for chaining

name

public ExternalTransitionConfigurer<S,E> name(String name)

Description copied from interface: TransitionConfigurer

Specify a name for this Transition.

Specified by:

name in interface TransitionConfigurer<ExternalTransitionConfigurer<S,E>,S,E>

Parameters:

name - the name

Returns:

configurer for chaining