io.nflow.engine.workflow.definition

Class WorkflowDefinition<S extends Enum<S> & WorkflowState>

java.lang.Object

io.nflow.engine.model.ModelObject

io.nflow.engine.workflow.definition.AbstractWorkflowDefinition<S>

io.nflow.engine.workflow.definition.WorkflowDefinition<S>

Type Parameters:

S - The enumeration of valid workflow states.

Direct Known Subclasses:

BulkWorkflow, CronWorkflow

public abstract class WorkflowDefinition<S extends Enum<S> & WorkflowState>
extends AbstractWorkflowDefinition<S>

The base class for enum based workflow definitions.

Field Summary

Fields inherited from class io.nflow.engine.workflow.definition.AbstractWorkflowDefinition

allowedTransitions, failureTransitions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkflowDefinition(String type, S initialState, S errorState) Create a workflow definition.
protected	WorkflowDefinition(String type, S initialState, S errorState, WorkflowSettings settings) Create a workflow definition with customized workflow settings.

Method Summary

Modifier and Type	Method and Description
Set<S>	getStates() Return all states of the workflow.

Methods inherited from class io.nflow.engine.workflow.definition.AbstractWorkflowDefinition

getAllowedTransitions, getDescription, getErrorState, getFailureTransitions, getInitialState, getMethod, getName, getSettings, getState, getSupportedSignals, getType, isAllowedNextAction, isStartState, permit, permit, setDescription, setName

Methods inherited from class io.nflow.engine.model.ModelObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkflowDefinition

protected WorkflowDefinition(String type,
                             S initialState,
                             S errorState)

Create a workflow definition.

Parameters:

type - The type of the workflow definition.

initialState - The initial state of the workflow.

errorState - The generic error state of the workflow.

WorkflowDefinition

protected WorkflowDefinition(String type,
                             S initialState,
                             S errorState,
                             WorkflowSettings settings)

Create a workflow definition with customized workflow settings.

Parameters:

type - The type of the workflow.

initialState - The initial state of the workflow.

errorState - The generic error state of the workflow.

settings - The workflow settings.

Method Detail

getStates

public Set<S> getStates()

Return all states of the workflow.

Specified by:

getStates in class AbstractWorkflowDefinition<S extends Enum<S> & WorkflowState>

Returns:

Set of workflow states.