org.apache.giraph.bsp

Enum ApplicationState

java.lang.Object

java.lang.Enum<ApplicationState>

org.apache.giraph.bsp.ApplicationState

All Implemented Interfaces:

Serializable, Comparable<ApplicationState>

public enum ApplicationState
extends Enum<ApplicationState>

State of the BSP application

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED Unrecoverable
FINISHED Successful completion
START_SUPERSTEP Start from a desired superstep
UNKNOWN Shouldn't be seen, just an initial state

Method Summary

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

UNKNOWN

public static final ApplicationState UNKNOWN

Shouldn't be seen, just an initial state

START_SUPERSTEP

public static final ApplicationState START_SUPERSTEP

Start from a desired superstep

FAILED

public static final ApplicationState FAILED

Unrecoverable

FINISHED

public static final ApplicationState FINISHED

Successful completion

Method Detail

values

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

Returns:

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

valueOf

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