org.apache.giraph.bsp.checkpoints

Enum CheckpointStatus

java.lang.Object

java.lang.Enum<CheckpointStatus>

org.apache.giraph.bsp.checkpoints.CheckpointStatus

All Implemented Interfaces:

Serializable, Comparable<CheckpointStatus>

public enum CheckpointStatus
extends Enum<CheckpointStatus>

Enum represents possible checkpoint state.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHECKPOINT Regular checkpoint
CHECKPOINT_AND_HALT Do checkpoint and then halt further computation
NONE Do nothing, no checkpoint required

Method Summary

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

NONE

public static final CheckpointStatus NONE

Do nothing, no checkpoint required

CHECKPOINT

public static final CheckpointStatus CHECKPOINT

Regular checkpoint

CHECKPOINT_AND_HALT

public static final CheckpointStatus CHECKPOINT_AND_HALT

Do checkpoint and then halt further computation

Method Detail

values

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

Returns:

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

valueOf

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