Package io.iworkflow.core

Class StateMovement

java.lang.Object

io.iworkflow.core.StateMovement

@Immutable
public abstract class StateMovement
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static StateMovement	DEAD_END_WORKFLOW_MOVEMENT
static StateMovement	FORCE_FAILING_WORKFLOW_MOVEMENT
static java.lang.String	RESERVED_STATE_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
StateMovement()

Method Summary

Modifier and Type	Method	Description
static <I> StateMovement	create(java.lang.Class<? extends WorkflowState<? extends I>> stateClass)
static <I> StateMovement	create(java.lang.Class<? extends WorkflowState<? extends I>> stateClass, I stateInput)
static <I> StateMovement	create(java.lang.Class<? extends WorkflowState<? extends I>> stateClass, I stateInput, WorkflowStateOptions stateOptionsOverride)
static StateMovement	create(java.lang.String stateId)	use the other one with WorkflowState class param if the stateId is provided by default, to make your code cleaner
static <I> StateMovement	create(java.lang.String stateId, I stateInput, WorkflowStateOptions stateOptionsOverride)	use the other one with WorkflowState class param if the stateId is provided by default, to make your code cleaner
static StateMovement	forceCompleteWorkflow()
static StateMovement	forceCompleteWorkflow(java.lang.Object output)
static StateMovement	forceFailWorkflow(java.lang.Object output)
abstract java.lang.String	getStateId()
abstract java.util.Optional<java.lang.Object>	getStateInput()
abstract java.util.Optional<WorkflowStateOptions>	getStateOptionsOverride()
static StateMovement	gracefulCompleteWorkflow()
static StateMovement	gracefulCompleteWorkflow(java.lang.Object output)

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_STATE_ID_PREFIX

public static final java.lang.String RESERVED_STATE_ID_PREFIX

See Also:

Constant Field Values

DEAD_END_WORKFLOW_MOVEMENT

public static final StateMovement DEAD_END_WORKFLOW_MOVEMENT

FORCE_FAILING_WORKFLOW_MOVEMENT

public static final StateMovement FORCE_FAILING_WORKFLOW_MOVEMENT

Constructor Detail

StateMovement

public StateMovement()

Method Detail

getStateId

public abstract java.lang.String getStateId()

getStateInput

public abstract java.util.Optional<java.lang.Object> getStateInput()

getStateOptionsOverride

public abstract java.util.Optional<WorkflowStateOptions> getStateOptionsOverride()

gracefulCompleteWorkflow

public static StateMovement gracefulCompleteWorkflow()

gracefulCompleteWorkflow

public static StateMovement gracefulCompleteWorkflow(java.lang.Object output)

forceCompleteWorkflow

public static StateMovement forceCompleteWorkflow()

forceCompleteWorkflow

public static StateMovement forceCompleteWorkflow(java.lang.Object output)

forceFailWorkflow

public static StateMovement forceFailWorkflow(java.lang.Object output)

create

public static <I> StateMovement create(java.lang.Class<? extends WorkflowState<? extends I>> stateClass,
                                       I stateInput,
                                       WorkflowStateOptions stateOptionsOverride)

Type Parameters:

I - Class type of the WorkflowState input

Parameters:

stateClass - required

stateInput - optional, can be null

stateOptionsOverride - optional, can be null. It is used to override the defined one in the State class

Returns:

state movement

create

public static <I> StateMovement create(java.lang.Class<? extends WorkflowState<? extends I>> stateClass,
                                       I stateInput)

Type Parameters:

I - Class type of the WorkflowState input

Parameters:

stateClass - required

stateInput - optional, can be null

Returns:

state movement

create

public static <I> StateMovement create(java.lang.Class<? extends WorkflowState<? extends I>> stateClass)

Type Parameters:

I - Class type of the WorkflowState input

Parameters:

stateClass - required

Returns:

state movement

create

public static <I> StateMovement create(java.lang.String stateId,
                                       I stateInput,
                                       WorkflowStateOptions stateOptionsOverride)

use the other one with WorkflowState class param if the stateId is provided by default, to make your code cleaner

Type Parameters:

I - Class type of the WorkflowState input

Parameters:

stateId - required

stateInput - optional, can be null

stateOptionsOverride - optional, can be null. It is used to override the defined one in the State class

Returns:

state movement

create

public static StateMovement create(java.lang.String stateId)

use the other one with WorkflowState class param if the stateId is provided by default, to make your code cleaner

Parameters:

stateId - stateId

Returns:

state movement