Module dk.cloudcreate.essentials.components.eventsourced.aggregates

Package dk.cloudcreate.essentials.components.eventsourced.aggregates.decider

Interface HandlerResult<ERROR,EVENT>

Type Parameters:

EVENT - The type of Events that can be returned by Handler.handle(Object, Object) and applied in the StateEvolver.applyEvent(Object, Object)

ERROR - The type of Error that can be returned by the Handler.handle(Object, Object) method

All Known Implementing Classes:

HandlerResult.Error, HandlerResult.Success

public sealed interface HandlerResult<ERROR,EVENT>
permits HandlerResult.Success<ERROR,EVENT>, HandlerResult.Error<ERROR,EVENT>

Captures that result of calling a Handler.handle(Object, Object) for a specific COMMAND and aggregate STATE
Concrete instances can either be of type HandlerResult.Success or type HandlerResult.Error

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	HandlerResult.Error<ERROR,EVENT>	Error variant of the HandlerResult
static final record	HandlerResult.Success<ERROR,EVENT>	Success variant of the HandlerResult

Method Summary

Modifier and Type	Method	Description
default HandlerResult.Error<ERROR,EVENT>	asError()	Convert the HandlerResult to an HandlerResult.Error
default HandlerResult.Success<ERROR,EVENT>	asSuccess()	Convert the HandlerResult to a HandlerResult.Success
static <EVENT, ERROR> HandlerResult.Error<ERROR,EVENT>	error(ERROR error)	Factory method for returning an ERROR from Handler.handle(Object, Object)
static <EVENT, ERROR> HandlerResult.Success<ERROR,EVENT>	events(EVENT... events)	Factory method for returning a list of EVENT's from Handler.handle(Object, Object)
static <EVENT, ERROR> HandlerResult.Success<ERROR,EVENT>	events(List<EVENT> events)	Factory method for returning a list of EVENT's from Handler.handle(Object, Object)
boolean	isError()	Did the command handling result in an error?
default boolean	isSuccess()	Was the result of the command handling a success?
default void	shouldFailWith(ERROR error)	Test oriented method that verify that the HandlerResult isError() and the HandlerResult.Error.error() is exactly same as the error parameter
default void	shouldSucceedWith(EVENT... events)	Test oriented method that verify that the HandlerResult isSuccess() and the HandlerResult.Success.events() contains exactly same events as the events parameter
default void	shouldSucceedWith(List<EVENT> events)	Test oriented method that verify that the HandlerResult isSuccess() and the HandlerResult.Success.events() contains exactly same events as the events parameter

Method Details

isError

boolean isError()

Did the command handling result in an error?

Returns:

Did the command handling result in an error?

isSuccess

default boolean isSuccess()

Was the result of the command handling a success?

Returns:

Was the result of the command handling a success?

asSuccess

default HandlerResult.Success<ERROR,EVENT> asSuccess()

Convert the HandlerResult to a HandlerResult.Success

Returns:

the HandlerResult converted to a HandlerResult.Success

Throws:

IllegalStateException - if the HandlerResult is an HandlerResult.Error

asError

default HandlerResult.Error<ERROR,EVENT> asError()

Convert the HandlerResult to an HandlerResult.Error

Returns:

the HandlerResult converted to an HandlerResult.Error

Throws:

IllegalStateException - if the HandlerResult is an HandlerResult.Success

shouldSucceedWith

default void shouldSucceedWith(EVENT... events)

Test oriented method that verify that the HandlerResult isSuccess() and the HandlerResult.Success.events() contains exactly same events as the events parameter

Parameters:

events - the events that we want to verify the HandlerResult.Success.events() contains

Throws:

IllegalStateException - in case the expectations aren't met

shouldSucceedWith

default void shouldSucceedWith(List<EVENT> events)

Test oriented method that verify that the HandlerResult isSuccess() and the HandlerResult.Success.events() contains exactly same events as the events parameter

Parameters:

events - the events that we want to verify the HandlerResult.Success.events() contains

Throws:

IllegalStateException - in case the expectations aren't met

shouldFailWith

default void shouldFailWith(ERROR error)

Test oriented method that verify that the HandlerResult isError() and the HandlerResult.Error.error() is exactly same as the error parameter

Parameters:

error - the error that we want to verify is the same as the HandlerResult.Error.error()

Throws:

IllegalStateException - in case the expectations aren't met

error

static <EVENT,
ERROR>
HandlerResult.Error<ERROR,EVENT> error(ERROR error)

Factory method for returning an ERROR from Handler.handle(Object, Object)

Type Parameters:

EVENT - The type of Events that can be returned by Handler.handle(Object, Object) and applied in the StateEvolver.applyEvent(Object, Object)

ERROR - The type of Error that can be returned by the Handler.handle(Object, Object) method

Parameters:

error - the error to return

Returns:

An Either with Either._1 containing the error

events

static <EVENT,
ERROR>
HandlerResult.Success<ERROR,EVENT> events(EVENT... events)

Factory method for returning a list of EVENT's from Handler.handle(Object, Object)

Type Parameters:

EVENT - The type of Events that can be returned by Handler.handle(Object, Object) and applied in the StateEvolver.applyEvent(Object, Object)

ERROR - The type of Error that can be returned by the Handler.handle(Object, Object) method

Parameters:

events - the events to return (is allowed to be empty)

Returns:

An Either with Either._2 containing a list of events

events

static <EVENT,
ERROR>
HandlerResult.Success<ERROR,EVENT> events(List<EVENT> events)

Factory method for returning a list of EVENT's from Handler.handle(Object, Object)

Type Parameters:

EVENT - The type of Events that can be returned by Handler.handle(Object, Object) and applied in the StateEvolver.applyEvent(Object, Object)

ERROR - The type of Error that can be returned by the Handler.handle(Object, Object) method

Parameters:

events - the events to return (is allowed to be empty)

Returns:

An Either with Either._2 containing a list of events