Package com.arjuna.ats.internal.arjuna.recovery

Enum PeriodicRecovery.Mode

java.lang.Object

java.lang.Enum<PeriodicRecovery.Mode>

com.arjuna.ats.internal.arjuna.recovery.PeriodicRecovery.Mode

All Implemented Interfaces:

Serializable, Comparable<PeriodicRecovery.Mode>, java.lang.constant.Constable

Enclosing class:

PeriodicRecovery

public static enum PeriodicRecovery.Mode
extends Enum<PeriodicRecovery.Mode>

state values indicating operating mode of scanning process for ad hoc threads and controlling behaviour of singleton periodic recovery thread. used to define values of field PeriodicRecovery._currentMode n.b. PeriodicRecovery._currentStatus may not transition to state SCANNING when PeriodicRecovery._currentStatus is in state SUSPENDED or TERMINATED. However, if a scan is in progress when PeriodicRecovery._currentMode transitions to state SUSPENDED or TERMINATED PeriodicRecovery._currentStatus may (temporarily) remain in state SCANNING before transitioning to state INACTIVE.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static PeriodicRecovery.Mode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PeriodicRecovery.Mode[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENABLED

public static final PeriodicRecovery.Mode ENABLED

state value indicating that new scans may proceed

SUSPENDED

public static final PeriodicRecovery.Mode SUSPENDED

state value indicating that new scans may not proceed and the periodic recovery thread should suspend

TERMINATED

public static final PeriodicRecovery.Mode TERMINATED

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

Method Details

values

public static PeriodicRecovery.Mode[] values()

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

Returns:

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

valueOf

public static PeriodicRecovery.Mode 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