com.yworks.yfiles.algorithms

Enum BfsDirection

java.lang.Object

java.lang.Enum<BfsDirection>

com.yworks.yfiles.algorithms.BfsDirection

All Implemented Interfaces:

Serializable, Comparable<BfsDirection>

public enum BfsDirection
extends Enum<BfsDirection>

See Also:

Bfs.getLayers(Graph, NodeList, BfsDirection, INodeMap, int)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH An edge direction specifier for both incoming and outgoing edges.
PREDECESSOR An edge direction specifier for incoming edges.
SUCCESSOR An edge direction specifier for outgoing edges.

Method Summary

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

BOTH

public static final BfsDirection BOTH

An edge direction specifier for both incoming and outgoing edges.

See Also:

Bfs.getLayers(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.NodeList, BfsDirection, com.yworks.yfiles.algorithms.INodeMap, int)

PREDECESSOR

public static final BfsDirection PREDECESSOR

An edge direction specifier for incoming edges.

See Also:

Bfs.getLayers(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.NodeList, BfsDirection, com.yworks.yfiles.algorithms.INodeMap, int)

SUCCESSOR

public static final BfsDirection SUCCESSOR

An edge direction specifier for outgoing edges.

See Also:

Bfs.getLayers(com.yworks.yfiles.algorithms.Graph, com.yworks.yfiles.algorithms.NodeList, BfsDirection, com.yworks.yfiles.algorithms.INodeMap, int)

Method Detail

fromOrdinal

public static final BfsDirection fromOrdinal(int ordinal)

value

public int value()

valueOf

public static BfsDirection 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.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

values

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

Returns:

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