Package com.powsybl.math.graph

Enum Class TraverseResult

java.lang.Object

java.lang.Enum<TraverseResult>

com.powsybl.math.graph.TraverseResult

All Implemented Interfaces:

Serializable, Comparable<TraverseResult>, Constable

public enum TraverseResult
extends Enum<TraverseResult>

Result of graph traversal step, used to decide whether to pursue or not current traversal.

• CONTINUE indicates that the traversal should go on,
• TERMINATE_PATH indicates that the current traversal path should stop,
• TERMINATE_TRAVERSER indicates that all the traversal paths should stop.

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTINUE	Indicates that traversal should continue
TERMINATE_PATH	Indicates that traversal should terminate on current path
TERMINATE_TRAVERSER	Indicates that traversal should break, i.e., terminate on all paths

Method Summary

Modifier and Type	Method	Description
static TraverseResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TraverseResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTINUE

public static final TraverseResult CONTINUE

Indicates that traversal should continue

TERMINATE_PATH

public static final TraverseResult TERMINATE_PATH

Indicates that traversal should terminate on current path

TERMINATE_TRAVERSER

public static final TraverseResult TERMINATE_TRAVERSER

Indicates that traversal should break, i.e., terminate on all paths

Method Details

values

public static TraverseResult[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TraverseResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null