org.apache.reef.driver.restart

Enum DriverRestartState

java.lang.Object

java.lang.Enum<DriverRestartState>

org.apache.reef.driver.restart.DriverRestartState

All Implemented Interfaces:

Serializable, Comparable<DriverRestartState>

public enum DriverRestartState
extends Enum<DriverRestartState>

Represents the current driver restart progress.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEGAN Driver has been notified of the restart by the runtime, but has not yet received its set of evaluator IDs to recover yet.
COMPLETED Driver has recovered all the evaluator IDs that it can, and the restart process is completed.
IN_PROGRESS Driver has received its set of evaluator IDs to recover.
NOT_RESTARTED Driver has not begun the restart progress yet.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNotRestarted() the negation of hasRestarted().
boolean	hasRestarted()
boolean	isRestarting()
static DriverRestartState	valueOf(String name) Returns the enum constant of this type with the specified name.
static DriverRestartState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_RESTARTED

public static final DriverRestartState NOT_RESTARTED

Driver has not begun the restart progress yet.

BEGAN

public static final DriverRestartState BEGAN

Driver has been notified of the restart by the runtime, but has not yet received its set of evaluator IDs to recover yet.

IN_PROGRESS

public static final DriverRestartState IN_PROGRESS

Driver has received its set of evaluator IDs to recover.

COMPLETED

public static final DriverRestartState COMPLETED

Driver has recovered all the evaluator IDs that it can, and the restart process is completed.

Method Detail

values

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

Returns:

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

valueOf

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

isRestarting

public boolean isRestarting()

Returns:

true if the restart is in process.

hasRestarted

public boolean hasRestarted()

Returns:

true if the driver began the restart process. Can be already done with the restart process.

hasNotRestarted

public boolean hasNotRestarted()

the negation of hasRestarted().