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

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

Class EventsToPersist<ID,EVENT_TYPE>

java.lang.Object

dk.cloudcreate.essentials.components.eventsourced.aggregates.EventsToPersist<ID,EVENT_TYPE>

Type Parameters:

ID - the aggregate id type

EVENT_TYPE - the type of event

public class EventsToPersist<ID,EVENT_TYPE>
extends Object

Wrapper object that captures the results of any command handling (e.g. static constructor method or instance command methods in FlexAggregate/AggregateRoot sub classes).
The purpose of this wrapper is to wrap information about the aggregate-id, event-order of last applied historic event (if any) and any events that were a side effect of the command method invocation

Field Summary

Fields

Modifier and Type	Field	Description
ID	aggregateId	The id of the aggregate this relates to
dk.cloudcreate.essentials.components.eventsourced.eventstore.postgresql.types.EventOrder	eventOrderOfLastRehydratedEvent	(Zero based event order) contains the eventOrder for the last (previous/historic) event applied during AggregateRoot.rehydrate(AggregateEventStream)/FlexAggregate.rehydrate(AggregateEventStream).
List<EVENT_TYPE>	events

Constructor Summary

Constructors

Constructor	Description
EventsToPersist(ID aggregateId, dk.cloudcreate.essentials.components.eventsourced.eventstore.postgresql.types.EventOrder eventOrderOfLastRehydratedEvent, EVENT_TYPE... events)
EventsToPersist(ID aggregateId, dk.cloudcreate.essentials.components.eventsourced.eventstore.postgresql.types.EventOrder eventOrderOfLastRehydratedEvent, List<EVENT_TYPE> events)

Method Summary

Modifier and Type	Method	Description
EventsToPersist<ID,EVENT_TYPE>	append(EventsToPersist<ID,EVENT_TYPE> appendEventsToPersist)	Immutable method that appends all events in appendEventsToPersist to the events in this instance.
static <ID,EVENT_TYPE,AGGREGATE_TYPE extends FlexAggregate<ID,AGGREGATE_TYPE>> EventsToPersist<ID,EVENT_TYPE>	events(FlexAggregate<ID,AGGREGATE_TYPE> aggregate, EVENT_TYPE... eventsToPersist)	Wrap the events that should be persisted relates to the given aggregate's command handling
static <ID,EVENT_TYPE> EventsToPersist<ID,EVENT_TYPE>	events(ID aggregateId, dk.cloudcreate.essentials.components.eventsourced.eventstore.postgresql.types.EventOrder eventOrderOfLastRehydratedEvent, EVENT_TYPE... eventsToPersist)	Wrap the events that should be persisted for this existing aggregate
Object	get(int index)	Get event at index.
static <ID,EVENT_TYPE> EventsToPersist<ID,EVENT_TYPE>	initialAggregateEvents(ID aggregateId, EVENT_TYPE... eventsToPersist)	Wrap the events that should be persisted for this new aggregate
boolean	isCommitted()
boolean	isEmpty()	Is the events empty
void	markEventsAsCommitted()
static <ID,EVENT_TYPE,AGGREGATE_TYPE extends FlexAggregate<ID,AGGREGATE_TYPE>> EventsToPersist<ID,EVENT_TYPE>	noEvents(FlexAggregate<ID,AGGREGATE_TYPE> aggregate)	Creates an empty EventsToPersist which is handy for a commanded method didn't have a side-effect (e.g.
static <ID,EVENT_TYPE> EventsToPersist<ID,EVENT_TYPE>	noEvents(ID aggregateId)	Creates an empty EventsToPersist which is handy for a commanded method didn't have a side-effect (e.g.
int	size()	Number of events.
Stream<EVENT_TYPE>	stream()	events Stream
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

aggregateId

public final ID aggregateId

The id of the aggregate this relates to

eventOrderOfLastRehydratedEvent

public final dk.cloudcreate.essentials.components.eventsourced.eventstore.postgresql.types.EventOrder eventOrderOfLastRehydratedEvent

(Zero based event order) contains the eventOrder for the last (previous/historic) event applied during AggregateRoot.rehydrate(AggregateEventStream)/FlexAggregate.rehydrate(AggregateEventStream). See EventOrder.NO_EVENTS_PREVIOUSLY_PERSISTED

events

public final List<EVENT_TYPE> events

Constructor Detail

EventsToPersist

public EventsToPersist(ID aggregateId,
                       dk.cloudcreate.essentials.components.eventsourced.eventstore.postgresql.types.EventOrder eventOrderOfLastRehydratedEvent,
                       List<EVENT_TYPE> events)

Parameters:

aggregateId - the aggregate id this relates to

eventOrderOfLastRehydratedEvent - (Zero based event order) contains the eventOrder for the last (previous/historic) event applied during AggregateRoot.rehydrate(AggregateEventStream)/FlexAggregate.rehydrate(AggregateEventStream). See EventOrder.NO_EVENTS_PREVIOUSLY_PERSISTED

events - the events to persist, which will be the result/side-effect of a command method invocation in an FlexAggregate).

EventsToPersist

public EventsToPersist(ID aggregateId,
                       dk.cloudcreate.essentials.components.eventsourced.eventstore.postgresql.types.EventOrder eventOrderOfLastRehydratedEvent,
                       EVENT_TYPE... events)

Parameters:

aggregateId - the aggregate id this relates to

eventOrderOfLastRehydratedEvent - (Zero based event order) contains the eventOrder for the last (previous/historic) event applied during AggregateRoot.rehydrate(AggregateEventStream)/FlexAggregate.rehydrate(AggregateEventStream). See EventOrder.NO_EVENTS_PREVIOUSLY_PERSISTED

events - the events to persist, which will be the result/side-effect of a command method invocation in an FlexAggregate).

Method Detail

initialAggregateEvents

public static <ID,EVENT_TYPE> EventsToPersist<ID,EVENT_TYPE> initialAggregateEvents(ID aggregateId,
                                                                                                EVENT_TYPE... eventsToPersist)

Wrap the events that should be persisted for this new aggregate

Type Parameters:

ID - the aggregate id type

Parameters:

aggregateId - the aggregate id this relates to

eventsToPersist - the events to persist, which will be the result/side-effect of a command method invocation in an FlexAggregate). May be empty if the command method invocation didn't result in any events (e.g. due to idempotency checks)

events

public static <ID,EVENT_TYPE> EventsToPersist<ID,EVENT_TYPE> events(ID aggregateId,
                                                                                dk.cloudcreate.essentials.components.eventsourced.eventstore.postgresql.types.EventOrder eventOrderOfLastRehydratedEvent,
                                                                                EVENT_TYPE... eventsToPersist)

Wrap the events that should be persisted for this existing aggregate

Type Parameters:

ID - the aggregate id type

Parameters:

aggregateId - the aggregate id this relates to

eventOrderOfLastRehydratedEvent - (Zero based event order) contains the eventOrder for the last (previous/historic) event applied during AggregateRoot.rehydrate(AggregateEventStream)/FlexAggregate.rehydrate(AggregateEventStream). See EventOrder.NO_EVENTS_PREVIOUSLY_PERSISTED

eventsToPersist - the events to persist, which will be the result/side-effect of a command method invocation in an FlexAggregate). May be empty if the command method invocation didn't result in any events (e.g. due to idempotency checks)

events

public static <ID,EVENT_TYPE,AGGREGATE_TYPE extends FlexAggregate<ID,AGGREGATE_TYPE>> EventsToPersist<ID,EVENT_TYPE> events(FlexAggregate<ID,AGGREGATE_TYPE> aggregate,
                                                                                                                                                    EVENT_TYPE... eventsToPersist)

Wrap the events that should be persisted relates to the given aggregate's command handling

Type Parameters:

ID - the aggregate id type

AGGREGATE_TYPE - the aggregate type

Parameters:

aggregate - the easy aggregate instance that the eventsToPersist

eventsToPersist - the events to persist, which will be the result/side-effect of a command method invocation in an FlexAggregate). May be empty if the command method invocation didn't result in any events (e.g. due to idempotency checks)

noEvents

public static <ID,EVENT_TYPE> EventsToPersist<ID,EVENT_TYPE> noEvents(ID aggregateId)

Creates an empty EventsToPersist which is handy for a commanded method didn't have a side-effect (e.g. due to idempotent handling)

Type Parameters:

ID - the aggregate id type

Parameters:

aggregateId - the aggregate id this relates to

noEvents

public static <ID,EVENT_TYPE,AGGREGATE_TYPE extends FlexAggregate<ID,AGGREGATE_TYPE>> EventsToPersist<ID,EVENT_TYPE> noEvents(FlexAggregate<ID,AGGREGATE_TYPE> aggregate)

Creates an empty EventsToPersist which is handy for a commanded method didn't have a side-effect (e.g. due to idempotent handling)

Type Parameters:

ID - the aggregate id type

AGGREGATE_TYPE - the aggregate type

Parameters:

aggregate - the easy aggregate instance

markEventsAsCommitted

public void markEventsAsCommitted()

isCommitted

public boolean isCommitted()

append

public EventsToPersist<ID,EVENT_TYPE> append(EventsToPersist<ID,EVENT_TYPE> appendEventsToPersist)

Immutable method that appends all events in appendEventsToPersist to the events in this instance. The result is returned as a NEW EventsToPersist instance that contains the combined list of events

Parameters:

appendEventsToPersist - the events to append to this instance

Returns:

The result is returned as a NEW EventsToPersist instance that contains the combined list of events. The new EventsToPersist retains the original value of the eventOrderOfLastRehydratedEvent

toString

public String toString()

Overrides:

toString in class Object

isEmpty

public boolean isEmpty()

Is the events empty

Returns:

Is the events empty

stream

public Stream<EVENT_TYPE> stream()

events Stream

Returns:

events Stream

size

public int size()

Number of events. Shorthand for {@link #events#size()}

Returns:

Shorthand for {@link #events#size()}

get

public Object get(int index)

Get event at index. Shorthand for {@link #events#get(int)}

Parameters:

index - the index on the events list

Returns:

Shorthand for {@link #events#get(int)}