org.azyva.dragom.reference

Enum ReferenceGraph.VisitAction

java.lang.Object

java.lang.Enum<ReferenceGraph.VisitAction>

org.azyva.dragom.reference.ReferenceGraph.VisitAction

All Implemented Interfaces:

Serializable, Comparable<ReferenceGraph.VisitAction>

Enclosing interface:

ReferenceGraph

public static enum ReferenceGraph.VisitAction
extends Enum<ReferenceGraph.VisitAction>

Action during the traversal of a ReferenceGraph.

These are used as flags and provided as part of an EnumSet since many of them can be pertinent for a single visit.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MATCHED Can be included with VISIT to indicate that the ModuleVersion is matched.
REPEATED Used in conjunction with VISIT when the ModuleVersion has already been visited.
STEP_IN Indicates we are stepping into a ModuleVersion during the traversal.
STEP_OUT Indicates we are stepping out of a ModuleVersion during the traversal.
VISIT Represents the actual visit of the leaf ModuleVersion.

Field Summary

Fields

Modifier and Type	Field and Description
static EnumSet<ReferenceGraph.VisitAction>	ENUM_SET_REPEATED_VISIT EnumSet of VisitAction's representing VISIT and REPEATED.
static EnumSet<ReferenceGraph.VisitAction>	ENUM_SET_REPEATED_VISIT_MATCHED EnumSet of VisitAction's representing VISIT, REPEATED and MATCHED.
static EnumSet<ReferenceGraph.VisitAction>	ENUM_SET_STEP_IN EnumSet of VisitAction's representing the single STEP_IN.
static EnumSet<ReferenceGraph.VisitAction>	ENUM_SET_STEP_OUT EnumSet of VisitAction's representing the single STEP_OUT.
static EnumSet<ReferenceGraph.VisitAction>	ENUM_SET_VISIT EnumSet of VisitAction's representing the single VISIT.
static EnumSet<ReferenceGraph.VisitAction>	ENUM_SET_VISIT_MATCHED EnumSet of VisitAction's representing VISIT and MATCHED.

Method Summary

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

STEP_IN

public static final ReferenceGraph.VisitAction STEP_IN

Indicates we are stepping into a ModuleVersion during the traversal. A matching STEP_OUT will occur when the traversal of the ModuleVersion is complete.

This VisitAction is mutually exclusive with all others.

Not used by ReferenceGraph.visitLeafModuleVersionReferencePaths(org.azyva.dragom.model.ModuleVersion, org.azyva.dragom.reference.ReferenceGraph.Visitor).

STEP_OUT

public static final ReferenceGraph.VisitAction STEP_OUT

Indicates we are stepping out of a ModuleVersion during the traversal. A matching STEP_IN will have occurred previously.

This VisitAction is mutually exclusive with all others.

Not used by ReferenceGraph.visitLeafModuleVersionReferencePaths(org.azyva.dragom.model.ModuleVersion, org.azyva.dragom.reference.ReferenceGraph.Visitor).

VISIT

public static final ReferenceGraph.VisitAction VISIT

Represents the actual visit of the leaf ModuleVersion. A STEP_IN will have occurred previously for the parent ModuleVersion. But if traversal is depth-first STEP_IN for all the ModuleVersion in the ReferencePath will have also occurred with no intervening visit for the intermediate ModuleVersion's.

STEP_OUT will occur thereafter for the parent ModuleVersion, after having visited all of its child ModuleVersion.

This is the only VisitAction used by visitLeafModuleVersionReferencePaths.

REPEATED

public static final ReferenceGraph.VisitAction REPEATED

Used in conjunction with VISIT when the ModuleVersion has already been visited.

If ReferenceGraph.ReentryMode.NO_REENTRY is specified when calling ReferenceGraph.traverseReferenceGraph(org.azyva.dragom.model.ModuleVersion, boolean, org.azyva.dragom.reference.ReferenceGraph.ReentryMode, org.azyva.dragom.reference.ReferenceGraph.Visitor), this will not occur. If ReferenceGraph.ReentryMode.ONLY_PARENT is specified, this will not occur for children of an already visited parent. It will occur only for the top-most revisited parent. If ReferenceGraph.ReentryMode.REENTRY is specified, this will occur for every ModuleVersion that is revisited.

Not used by visitLeafModuleVersionReferencePaths.

MATCHED

public static final ReferenceGraph.VisitAction MATCHED

Can be included with VISIT to indicate that the ModuleVersion is matched.

Field Detail

ENUM_SET_STEP_IN

public static final EnumSet<ReferenceGraph.VisitAction> ENUM_SET_STEP_IN

EnumSet of VisitAction's representing the single STEP_IN.

ENUM_SET_STEP_OUT

public static final EnumSet<ReferenceGraph.VisitAction> ENUM_SET_STEP_OUT

EnumSet of VisitAction's representing the single STEP_OUT.

ENUM_SET_VISIT

public static final EnumSet<ReferenceGraph.VisitAction> ENUM_SET_VISIT

EnumSet of VisitAction's representing the single VISIT.

ENUM_SET_REPEATED_VISIT

public static final EnumSet<ReferenceGraph.VisitAction> ENUM_SET_REPEATED_VISIT

EnumSet of VisitAction's representing VISIT and REPEATED.

ENUM_SET_VISIT_MATCHED

public static final EnumSet<ReferenceGraph.VisitAction> ENUM_SET_VISIT_MATCHED

EnumSet of VisitAction's representing VISIT and MATCHED.

ENUM_SET_REPEATED_VISIT_MATCHED

public static final EnumSet<ReferenceGraph.VisitAction> ENUM_SET_REPEATED_VISIT_MATCHED

EnumSet of VisitAction's representing VISIT, REPEATED and MATCHED.

Method Detail

values

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

Returns:

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

valueOf

public static ReferenceGraph.VisitAction 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