Package io.nflow.engine.workflow.curated

Class State

java.lang.Object

io.nflow.engine.model.ModelObject

io.nflow.engine.workflow.curated.State

All Implemented Interfaces:

WorkflowState

public class State
extends ModelObject
implements WorkflowState

A simple implementation of the WorkflowState interface that can be used in any workflow definition, if more advanced implementation is not needed.

Constructor Summary

Constructors

Constructor	Description
State(String name)	Creates a workflow state with given name and type normal.
State(String name, WorkflowStateType type)	Creates a workflow state with given name and type.
State(String name, WorkflowStateType type, String description)	Creates a workflow state with given name, description and type.
State(String name, String description)	Creates a workflow state with given name and description and type normal.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the workflow state.
WorkflowStateType	getType()	Return the workflow state type.
String	name()	Return the name of the workflow state.

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

State

public State(String name)

Creates a workflow state with given name and type normal. The name is also used as the description of the state.

Parameters:

name - The name of the state.

State

public State(String name,
             WorkflowStateType type)

Creates a workflow state with given name and type. The name is also used as the description of the state.

Parameters:

name - The name of the state.

type - The workflow state type.

State

public State(String name,
             String description)

Creates a workflow state with given name and description and type normal.

Parameters:

name - The name of the state.

description - The longer description of the state.

State

public State(String name,
             WorkflowStateType type,
             String description)

Creates a workflow state with given name, description and type.

Parameters:

name - The name of the state.

type - The workflow state type.

description - The longer description of the state.

Method Detail

name

public String name()

Description copied from interface: WorkflowState

Return the name of the workflow state.

Specified by:

name in interface WorkflowState

Returns:

The name.

getType

public WorkflowStateType getType()

Description copied from interface: WorkflowState

Return the workflow state type.

Specified by:

getType in interface WorkflowState

Returns:

The workflow state type.

getDescription

public String getDescription()

Description copied from interface: WorkflowState

Return the description of the workflow state. Default implementation returns WorkflowState.name().

Specified by:

getDescription in interface WorkflowState

Returns:

The description.