Package io.github.zero88.schedulerx.impl

Class TriggerContextFactory

java.lang.Object

io.github.zero88.schedulerx.impl.TriggerContextFactory

@Internal
public final class TriggerContextFactory
extends Object

The factory to create trigger context.

Since:

2.0.0

Method Summary

Modifier and Type	Method	Description
static @NotNull TriggerContext	cancel(String triggerType, long tick)	Create a trigger context in TriggerCondition.TriggerStatus.STOPPED state with TriggerCondition.ReasonCode.ON_CANCEL reason.
static TriggerContext	error(String triggerType, String reason, @Nullable Throwable cause)	Create a trigger context in TriggerCondition.TriggerStatus.ERROR state.
static @NotNull TriggerContext	executed(@NotNull TriggerContext ctx)	Transition trigger context to TriggerCondition.TriggerStatus.EXECUTED state.
static @NotNull TriggerContext	kickoff(@NotNull String triggerType, @NotNull Instant firedAt, long tick)	Create trigger context in TriggerCondition.TriggerStatus.KICKOFF state
static <T> @NotNull TriggerContext	kickoff(@NotNull String triggerType, @NotNull Instant firedAt, long tick, T info)	Create trigger context in TriggerCondition.TriggerStatus.KICKOFF state
static @NotNull TriggerContext	ready(@NotNull TriggerContext ctx)	Transition trigger context to TriggerCondition.TriggerStatus.READY state.
static @NotNull TriggerContext	rescheduled(@NotNull String triggerType, long tick)	Create trigger context in TriggerCondition.TriggerStatus.SCHEDULED state with TriggerCondition.ReasonCode.ON_RESCHEDULE reason
static @NotNull TriggerContext	scheduled(@NotNull String triggerType)	Create trigger context in TriggerCondition.TriggerStatus.SCHEDULED state with TriggerCondition.ReasonCode.ON_SCHEDULE reason
static @NotNull TriggerContext	skip(@NotNull TriggerContext ctx, @NotNull String reason)	Transition trigger context to TriggerCondition.TriggerStatus.SKIPPED state.
static @NotNull TriggerContext	skip(@NotNull TriggerContext ctx, @NotNull String reason, @NotNull Throwable cause)	Transition trigger context to TriggerCondition.TriggerStatus.SKIPPED state.
static @NotNull TriggerContext	stop(@NotNull TriggerContext ctx, @Nullable String reason)	Transition trigger context to TriggerCondition.TriggerStatus.STOPPED state.

Methods inherited from class java.lang.Object

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

Method Details

scheduled

@NotNull
public static @NotNull TriggerContext scheduled(@NotNull
 @NotNull String triggerType)

Create trigger context in TriggerCondition.TriggerStatus.SCHEDULED state with TriggerCondition.ReasonCode.ON_SCHEDULE reason

Parameters:

triggerType - the trigger type

rescheduled

@NotNull
public static @NotNull TriggerContext rescheduled(@NotNull
 @NotNull String triggerType,
 long tick)

Create trigger context in TriggerCondition.TriggerStatus.SCHEDULED state with TriggerCondition.ReasonCode.ON_RESCHEDULE reason

Parameters:

triggerType - the trigger type

tick - the tick at the rescheduled time

error

public static TriggerContext error(String triggerType,
 String reason,
 @Nullable
 @Nullable Throwable cause)

Create a trigger context in TriggerCondition.TriggerStatus.ERROR state.

Parameters:

triggerType - the trigger type

reason - the transition reason

cause - the failed cause

cancel

@NotNull
public static @NotNull TriggerContext cancel(String triggerType,
 long tick)

Create a trigger context in TriggerCondition.TriggerStatus.STOPPED state with TriggerCondition.ReasonCode.ON_CANCEL reason.

Parameters:

triggerType - the trigger type

tick - the current tick

kickoff

@NotNull
public static @NotNull TriggerContext kickoff(@NotNull
 @NotNull String triggerType,
 @NotNull
 @NotNull Instant firedAt,
 long tick)

Create trigger context in TriggerCondition.TriggerStatus.KICKOFF state

Parameters:

triggerType - the trigger type

firedAt - the fired at

tick - the tick

kickoff

@NotNull
public static <T> @NotNull TriggerContext kickoff(@NotNull
 @NotNull String triggerType,
 @NotNull
 @NotNull Instant firedAt,
 long tick,
 @Nullable
 T info)

Create trigger context in TriggerCondition.TriggerStatus.KICKOFF state

Parameters:

triggerType - the trigger type

firedAt - the fired at

tick - the tick

info - the trigger context info

ready

@NotNull
public static @NotNull TriggerContext ready(@NotNull
 @NotNull TriggerContext ctx)

Transition trigger context to TriggerCondition.TriggerStatus.READY state.

Parameters:

ctx - the current trigger context

executed

@NotNull
public static @NotNull TriggerContext executed(@NotNull
 @NotNull TriggerContext ctx)

Transition trigger context to TriggerCondition.TriggerStatus.EXECUTED state.

Parameters:

ctx - the current trigger context

skip

@NotNull
public static @NotNull TriggerContext skip(@NotNull
 @NotNull TriggerContext ctx,
 @NotNull
 @NotNull String reason)

Transition trigger context to TriggerCondition.TriggerStatus.SKIPPED state.

Parameters:

ctx - the current trigger context

reason - the transition reason

skip

@NotNull
public static @NotNull TriggerContext skip(@NotNull
 @NotNull TriggerContext ctx,
 @NotNull
 @NotNull String reason,
 @NotNull
 @NotNull Throwable cause)

Transition trigger context to TriggerCondition.TriggerStatus.SKIPPED state.

Parameters:

ctx - the current trigger context

reason - the transition reason

cause - the transition cause

stop

@NotNull
public static @NotNull TriggerContext stop(@NotNull
 @NotNull TriggerContext ctx,
 @Nullable
 @Nullable String reason)

Transition trigger context to TriggerCondition.TriggerStatus.STOPPED state.

Parameters:

ctx - the current trigger context

reason - the transition reason