com.fnproject.fn.api.flow

Enum Flow.FlowState

java.lang.Object

java.lang.Enum<Flow.FlowState>

com.fnproject.fn.api.flow.Flow.FlowState

All Implemented Interfaces:

Serializable, Comparable<Flow.FlowState>

Enclosing interface:

Flow

public static enum Flow.FlowState
extends Enum<Flow.FlowState>

Represents the possible end states of a Flow object, i.e. of the whole collection of tasks in the flow.

• UNKNOWN indicates that the state of the flow is unknown or invalid
• SUCCEEDED indicates that the flow ran to completion (i.e. all stages completed successfully or exceptionally)
• FAILED indicates that the flow failed during its execution, e.g. due to corrupted internal state
• CANCELLED indicates that the flow was cancelled by the user
• KILLED indicates that the flow was killed by the user

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED
FAILED
KILLED
SUCCEEDED
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static Flow.FlowState	valueOf(String name) Returns the enum constant of this type with the specified name.
static Flow.FlowState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final Flow.FlowState UNKNOWN

SUCCEEDED

public static final Flow.FlowState SUCCEEDED

FAILED

public static final Flow.FlowState FAILED

CANCELLED

public static final Flow.FlowState CANCELLED

KILLED

public static final Flow.FlowState KILLED

Method Detail

values

public static Flow.FlowState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Flow.FlowState c : Flow.FlowState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Flow.FlowState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null