com.arjuna.ats.internal.arjuna.recovery

Enum RecoveryManagerStatus

java.lang.Object

java.lang.Enum<RecoveryManagerStatus>

com.arjuna.ats.internal.arjuna.recovery.RecoveryManagerStatus

All Implemented Interfaces:

Serializable, Comparable<RecoveryManagerStatus>

public enum RecoveryManagerStatus
extends Enum<RecoveryManagerStatus>

Exposes the current status of the periodic recovery thread as reported by RecoveryManagerImple.trySuspendScan(boolean)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENABLED state value indicating that new scans may proceed (PeriodicRecovery.Mode.ENABLED)
SUSPENDED state value indicating that new scans may not proceed and the periodic recovery thread should suspend (PeriodicRecovery.Mode.SUSPENDED)
TERMINATED state value indicating that new scans may not proceed and that the singleton PeriodicRecovery thread instance should exit if it is still running (PeriodicRecovery.Mode.TERMINATED)

Method Summary

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

ENABLED

public static final RecoveryManagerStatus ENABLED

state value indicating that new scans may proceed (PeriodicRecovery.Mode.ENABLED)

SUSPENDED

public static final RecoveryManagerStatus SUSPENDED

state value indicating that new scans may not proceed and the periodic recovery thread should suspend (PeriodicRecovery.Mode.SUSPENDED)

TERMINATED

public static final RecoveryManagerStatus TERMINATED

state value indicating that new scans may not proceed and that the singleton PeriodicRecovery thread instance should exit if it is still running (PeriodicRecovery.Mode.TERMINATED)

Method Detail

values

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

Returns:

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

valueOf

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