- java.lang.Object
-
- java.lang.Enum<TraverseResult>
-
- com.powsybl.math.graph.TraverseResult
-
- All Implemented Interfaces:
Serializable
,Comparable<TraverseResult>
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
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CONTINUE
Indicates that traversal should continueTERMINATE_PATH
Indicates that traversal should terminate on current pathTERMINATE_TRAVERSER
Indicates that traversal should break, i.e., terminate on all paths
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static TraverseResult
valueOf(String name)
Returns the enum constant of this type with the specified name.static TraverseResult[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static TraverseResult[] 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 (TraverseResult c : TraverseResult.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TraverseResult 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 nameNullPointerException
- if the argument is null
-
-