Package org.axonframework.eventsourcing.eventstore

Interface SourcingCondition

All Superinterfaces:

EventsCondition

public sealed interface SourcingCondition
extends EventsCondition

Interface describing the condition to source events from an Event Store.

The condition has a mandatory EventsCondition.criteria() used to retrieve the exact sequence of events to source the model(s). The start() operation defines the start point when sourcing events that the EventStoreTransaction is interested in.

Since:

5.0.0

Author:

Michal Negacz, Milan Savić, Marco Amann, Sara Pellegrini, Steven van Beelen

Method Summary

Modifier and Type	Method	Description
static SourcingCondition	conditionFor(Position position, EventCriteria criteria)	Construct a SourcingCondition used to source a model based on the given criteria.
static SourcingCondition	conditionFor(SourcingStrategy sourcingStrategy, EventCriteria criteria)	Construct a SourcingCondition used to source a model based on the given criteria and sourcing strategy.
static SourcingCondition	conditionFor(EventCriteria criteria)	Construct a SourcingCondition used to source a model based on the given criteria.
SourcingCondition	or(SourcingCondition other)	Merges this SourcingCondition with the given other SourcingCondition, by combining their search criteria and sourcing strategies.
default Position	start()	Deprecated, for removal: This API element is subject to removal in a future version. use strategy()'s and check for the absolute mode
default SourcingStrategy	strategy()	The sourcing strategy used for this sourcing condition.

Methods inherited from interface org.axonframework.messaging.eventstreaming.EventsCondition

criteria, matches

Method Details

conditionFor

static SourcingCondition conditionFor(EventCriteria criteria)

Construct a SourcingCondition used to source a model based on the given criteria.

Parameters:

criteria - the EventCriteria used as the EventsCondition.criteria()

Returns:

a SourcingCondition that will retrieve an event sequence matching the given criteria

Throws:

NullPointerException - if any argument is null

conditionFor

static SourcingCondition conditionFor(Position position,
 EventCriteria criteria)

Construct a SourcingCondition used to source a model based on the given criteria.

Will start the sequence at the given absolute position value using the absolute sourcing strategy.

Parameters:

position - the position to use for the absolute sourcing strategy

criteria - the EventCriteria used as the EventsCondition.criteria()

Returns:

a SourcingCondition that will retrieve an event sequence matching the given criteria, starting at the given position

Throws:

NullPointerException - if any argument is null

conditionFor

static SourcingCondition conditionFor(SourcingStrategy sourcingStrategy,
 EventCriteria criteria)

Construct a SourcingCondition used to source a model based on the given criteria and sourcing strategy.

Parameters:

sourcingStrategy - the SourcingStrategy used to construct the message stream

criteria - the EventCriteria used as the EventsCondition.criteria()

Returns:

a SourcingCondition that will retrieve an event sequence matching the given criteria, according to the given sourcingStrategy

Throws:

NullPointerException - if any argument is null

start

@Deprecated(since="5.1.0",
            forRemoval=true)
default Position start()

Deprecated, for removal: This API element is subject to removal in a future version.

use strategy()'s and check for the absolute mode

The start position in the event sequence to source. Defaults to Position.START to ensure we start at the beginning of the sequence's stream complying to the EventsCondition.criteria().

Returns:

the start position in the event sequence to source, never null

strategy

default SourcingStrategy strategy()

The sourcing strategy used for this sourcing condition.

Returns:

a SourcingStrategy, never null

or

SourcingCondition or(SourcingCondition other)

Merges this SourcingCondition with the given other SourcingCondition, by combining their search criteria and sourcing strategies.

Warning: if the sourcing strategies cannot be combined, this method will fail with an UnsupportedOperationException. If both sourcing strategies use absolute positioning, then the merged condition might return some events that neither of the original conditions would have returned on their own.

For positional strategies, usually the earlier starting point (minimum start value) will be used in the final merged condition.

Parameters:

other - the SourcingCondition to combine with this SourcingCondition

Returns:

a combined SourcingCondition based on this SourcingCondition and the given other

Throws:

NullPointerException - if any argument is null

UnsupportedOperationException - if the strategies are uncombinable