org.apache.giraph.graph

Enum GraphFunctions

java.lang.Object

java.lang.Enum<GraphFunctions>

org.apache.giraph.graph.GraphFunctions

All Implemented Interfaces:

Serializable, Comparable<GraphFunctions>

public enum GraphFunctions
extends Enum<GraphFunctions>

Each compute node running on the underlying cluster is marked with this enum to indicate the worker or master task(s) it must perform during job runs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Do master, worker, and ZooKeeper
ALL_EXCEPT_ZOOKEEPER Do master and worker
MASTER_ONLY Only be the master
MASTER_ZOOKEEPER_ONLY Only be the master and ZooKeeper
UNKNOWN Undecided yet
WORKER_ONLY Only be the worker

Method Summary

Modifier and Type	Method and Description
boolean	isKnown()
abstract boolean	isMaster() Tell whether this function acts as a master.
boolean	isNotAWorker()
boolean	isUnknown()
abstract boolean	isWorker() Tell whether this function acts as a worker.
abstract boolean	isZooKeeper() Tell whether this function acts as a ZooKeeper server.
static GraphFunctions	valueOf(String name) Returns the enum constant of this type with the specified name.
static GraphFunctions[]	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 GraphFunctions UNKNOWN

Undecided yet

MASTER_ONLY

public static final GraphFunctions MASTER_ONLY

Only be the master

MASTER_ZOOKEEPER_ONLY

public static final GraphFunctions MASTER_ZOOKEEPER_ONLY

Only be the master and ZooKeeper

WORKER_ONLY

public static final GraphFunctions WORKER_ONLY

Only be the worker

ALL

public static final GraphFunctions ALL

Do master, worker, and ZooKeeper

ALL_EXCEPT_ZOOKEEPER

public static final GraphFunctions ALL_EXCEPT_ZOOKEEPER

Do master and worker

Method Detail

values

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

Returns:

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

valueOf

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

isMaster

public abstract boolean isMaster()

Tell whether this function acts as a master.

Returns:

true iff this map function is a master

isWorker

public abstract boolean isWorker()

Tell whether this function acts as a worker.

Returns:

true iff this map function is a worker

isZooKeeper

public abstract boolean isZooKeeper()

Tell whether this function acts as a ZooKeeper server.

Returns:

true iff this map function is a zookeeper server

isKnown

public boolean isKnown()

isUnknown

public boolean isUnknown()

isNotAWorker

public boolean isNotAWorker()