org.apache.flink.graph

Enum EdgeDirection

java.lang.Object

java.lang.Enum<EdgeDirection>

org.apache.flink.graph.EdgeDirection

All Implemented Interfaces:

Serializable, Comparable<EdgeDirection>

public enum EdgeDirection
extends Enum<EdgeDirection>

The EdgeDirection is used to select a node's neighborhood by the Graph.groupReduceOnEdges(EdgesFunction, EdgeDirection), Graph.groupReduceOnEdges(EdgesFunctionWithVertexValue, EdgeDirection), Graph.groupReduceOnNeighbors(NeighborsFunction, EdgeDirection), Graph.groupReduceOnNeighbors(NeighborsFunctionWithVertexValue, EdgeDirection), Graph.reduceOnEdges(ReduceEdgesFunction, EdgeDirection) and Graph.reduceOnNeighbors(ReduceNeighborsFunction, EdgeDirection) methods.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL
IN
OUT

Method Summary

Methods

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

IN

public static final EdgeDirection IN

OUT

public static final EdgeDirection OUT

ALL

public static final EdgeDirection ALL

Method Detail

values

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

Returns:

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

valueOf

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