Enum Class StopType

java.lang.Object

java.lang.Enum<StopType>

io.superdurable.dex.StopType

All Implemented Interfaces:

Serializable, Comparable<StopType>, Constable

public enum StopType
extends Enum<StopType>

Selects how Client.stopFlow(String) ends a running Flow.

Pass the value through StopFlowOptions. The selected mode determines the terminal status that clients observe when they later describe or wait for the Flow.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCEL	Requests cooperative cancellation.
FAIL	Ends the Flow as failed.
TERMINATE	Terminates the Flow immediately.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CANCEL

public static final StopType CANCEL

Requests cooperative cancellation.

TERMINATE

public static final StopType TERMINATE

Terminates the Flow immediately.

FAIL

public static final StopType FAIL

Ends the Flow as failed.

Method Details

values

public static StopType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StopType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null