Enum Class StepAttemptProgress

java.lang.Object

java.lang.Enum<StepAttemptProgress>

io.superdurable.dex.StepAttemptProgress

All Implemented Interfaces:

Serializable, Comparable<StepAttemptProgress>, Constable

public enum StepAttemptProgress
extends Enum<StepAttemptProgress>

Describes how far a failed Step method progressed across all its attempts.

Use RecoveryErrorInfo.getAttemptProgress() during recovery to decide whether handler side effects may need reconciliation. Only NOT_STARTED rules out handler execution. See that accessor for an example.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOT_COMPLETED	Some attempt may have run, but none completed; side effects may have happened.
NOT_STARTED	The handler did not run in any attempt of this Step method call.
UNSPECIFIED	The Server did not report progress; treat this as NOT_COMPLETED.

Method Summary

Modifier and Type	Method	Description
static StepAttemptProgress	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StepAttemptProgress[]	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

UNSPECIFIED

public static final StepAttemptProgress UNSPECIFIED

The Server did not report progress; treat this as NOT_COMPLETED.

NOT_STARTED

public static final StepAttemptProgress NOT_STARTED

The handler did not run in any attempt of this Step method call.

NOT_COMPLETED

public static final StepAttemptProgress NOT_COMPLETED

Some attempt may have run, but none completed; side effects may have happened.

Method Details

values

public static StepAttemptProgress[] 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 StepAttemptProgress 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