org.apache.giraph.bsp

Enum SuperstepState

java.lang.Object

java.lang.Enum<SuperstepState>

org.apache.giraph.bsp.SuperstepState

All Implemented Interfaces:

Serializable, Comparable<SuperstepState>

public enum SuperstepState
extends Enum<SuperstepState>

State of a coordinated superstep

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_SUPERSTEPS_DONE All supersteps are complete
CHECKPOINT_AND_HALT Execution halted
INITIAL Nothing happened yet
THIS_SUPERSTEP_DONE This superstep completed correctly
WORKER_FAILURE A worker died during this superstep

Method Summary

Modifier and Type	Method and Description
boolean	isExecutionComplete() Returns true if execution has to be stopped after this superstep.
static SuperstepState	valueOf(String name) Returns the enum constant of this type with the specified name.
static SuperstepState[]	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

INITIAL

public static final SuperstepState INITIAL

Nothing happened yet

WORKER_FAILURE

public static final SuperstepState WORKER_FAILURE

A worker died during this superstep

THIS_SUPERSTEP_DONE

public static final SuperstepState THIS_SUPERSTEP_DONE

This superstep completed correctly

ALL_SUPERSTEPS_DONE

public static final SuperstepState ALL_SUPERSTEPS_DONE

All supersteps are complete

CHECKPOINT_AND_HALT

public static final SuperstepState CHECKPOINT_AND_HALT

Execution halted

Method Detail

values

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

Returns:

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

valueOf

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

isExecutionComplete

public boolean isExecutionComplete()

Returns true if execution has to be stopped after this superstep.

Returns:

whether execution is complete.