org.eclipse.microprofile.lra.annotation

Enum CompensatorStatus

java.lang.Object

java.lang.Enum<CompensatorStatus>

org.eclipse.microprofile.lra.annotation.CompensatorStatus

All Implemented Interfaces:

Serializable, Comparable<CompensatorStatus>

public enum CompensatorStatus
extends Enum<CompensatorStatus>

The status of a participant. The status is only valid after the coordinator has told the participant to complete or compensate. The name value of the enum should be returned by participant methods marked with the Status annotation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Compensated The Compensator has successfully compensated for the LRA
Compensating The Compensator is currently compensating for the LRA
Completed The Compensator has confirmed
Completing The Compensator is tidying up after being told to complete
FailedToCompensate The Compensator was not able to compensate for the LRA (and must remember it could not compensate until such time that it receives a forget message)
FailedToComplete The Compensator was unable to tidy-up

Method Summary

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

Compensating

public static final CompensatorStatus Compensating

The Compensator is currently compensating for the LRA

Compensated

public static final CompensatorStatus Compensated

The Compensator has successfully compensated for the LRA

FailedToCompensate

public static final CompensatorStatus FailedToCompensate

The Compensator was not able to compensate for the LRA (and must remember it could not compensate until such time that it receives a forget message)

Completing

public static final CompensatorStatus Completing

The Compensator is tidying up after being told to complete

Completed

public static final CompensatorStatus Completed

The Compensator has confirmed

FailedToComplete

public static final CompensatorStatus FailedToComplete

The Compensator was unable to tidy-up

Method Detail

values

public static CompensatorStatus[] 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 (CompensatorStatus c : CompensatorStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static CompensatorStatus 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