Package org.occurrent.subscription

Interface StartAt

All Known Implementing Classes:

StartAt.Default, StartAt.Dynamic, StartAt.Now, StartAt.StartAtSubscriptionPosition

public sealed interface StartAt
permits StartAt.Now, StartAt.Default, StartAt.Dynamic, StartAt.StartAtSubscriptionPosition

Specifies in which position a subscription should start when subscribing to it

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StartAt.Default
static final class	StartAt.Dynamic
static final class	StartAt.Now
static final class	StartAt.StartAtSubscriptionPosition
static final record	StartAt.SubscriptionModelContext

Method Summary

Modifier and Type	Method	Description
static StartAt	dynamic(Function<StartAt.SubscriptionModelContext,StartAt> supplier)	Create a "dynamic" start at position that may change during the life-cycle of a subscription model.
static StartAt	dynamic(Supplier<StartAt> supplier)	Create a "dynamic" start at position that may change during the life-cycle of a subscription model.
StartAt	get(StartAt.SubscriptionModelContext context)
default boolean	isDefault()
default boolean	isDynamic()
default boolean	isNow()
static StartAt.Now	now()	Start subscribing at this moment in time
static StartAt.Default	subscriptionModelDefault()	Start subscribing to the subscription model default.
static StartAt	subscriptionPosition(SubscriptionPosition subscriptionPosition)	Start subscribing to the subscription from the given subscription position

Method Details

get

StartAt get(StartAt.SubscriptionModelContext context)

isNow

default boolean isNow()

isDefault

default boolean isDefault()

isDynamic

default boolean isDynamic()

now

static StartAt.Now now()

Start subscribing at this moment in time

subscriptionModelDefault

static StartAt.Default subscriptionModelDefault()

Start subscribing to the subscription model default. Typically, this would be the same as "now", but subscription models may override this default behavior e.g. to start from the last stored position instead of now.

subscriptionPosition

static StartAt subscriptionPosition(SubscriptionPosition subscriptionPosition)

Start subscribing to the subscription from the given subscription position

dynamic

static StartAt dynamic(Supplier<StartAt> supplier)

Create a "dynamic" start at position that may change during the life-cycle of a subscription model. For example, it could return the latest subscription position from a subscription position storage.

dynamic

static StartAt dynamic(Function<StartAt.SubscriptionModelContext,StartAt> supplier)

Create a "dynamic" start at position that may change during the life-cycle of a subscription model. For example, it could return the latest subscription position from a subscription position storage.