Package org.springframework.statemachine

Interface StateMachineEventResult<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Known Implementing Classes:

StateMachineEventResult.DefaultStateMachineEventResult

public interface StateMachineEventResult<S,E>

Interface defining a result for sending an event to a statemachine.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StateMachineEventResult.DefaultStateMachineEventResult<S,E>
static enum	StateMachineEventResult.ResultType	Enumeration of a result type indicating whether a region accepted, denied or deferred an event.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<Void>	complete()	Gets a mono representing completion.
static <S, E> StateMachineEventResult<S,E>	from(Region<S,E> region, org.springframework.messaging.Message<E> message, StateMachineEventResult.ResultType resultType)	Create a StateMachineEventResult from a Region, Message and a StateMachineEventResult.ResultType.
static <S, E> StateMachineEventResult<S,E>	from(Region<S,E> region, org.springframework.messaging.Message<E> message, StateMachineEventResult.ResultType resultType, reactor.core.publisher.Mono<Void> complete)	Create a StateMachineEventResult from a Region, Message, a StateMachineEventResult.ResultType and completion Mono.
org.springframework.messaging.Message<E>	getMessage()	Gets the message.
Region<S,E>	getRegion()	Gets the region.
StateMachineEventResult.ResultType	getResultType()	Gets the result type.

Method Details

getRegion

Region<S,E> getRegion()

Gets the region.

Returns:

the region

getMessage

org.springframework.messaging.Message<E> getMessage()

Gets the message.

Returns:

the message

getResultType

StateMachineEventResult.ResultType getResultType()

Gets the result type.

Returns:

the result type

complete

reactor.core.publisher.Mono<Void> complete()

Gets a mono representing completion. Will have exception in a normal reactive chain if there is one.

Returns:

the mono for completion

from

static <S,
E> StateMachineEventResult<S,E> from(Region<S,E> region,
 org.springframework.messaging.Message<E> message,
 StateMachineEventResult.ResultType resultType)

Create a StateMachineEventResult from a Region, Message and a StateMachineEventResult.ResultType.

Type Parameters:

S - the type of state

E - the type of event

Parameters:

region - the region

message - the message

resultType - the result type

Returns:

the state machine event result

from

static <S,
E> StateMachineEventResult<S,E> from(Region<S,E> region,
 org.springframework.messaging.Message<E> message,
 StateMachineEventResult.ResultType resultType,
 reactor.core.publisher.Mono<Void> complete)

Create a StateMachineEventResult from a Region, Message, a StateMachineEventResult.ResultType and completion Mono.

Type Parameters:

S - the type of state

E - the type of event

Parameters:

region - the region

message - the message

resultType - the result type

complete - the completion mono

Returns:

the state machine event result