org.azyva.dragom.reference

Enum ReferenceGraph.VisitControl

java.lang.Object

java.lang.Enum<ReferenceGraph.VisitControl>

org.azyva.dragom.reference.ReferenceGraph.VisitControl

All Implemented Interfaces:

Serializable, Comparable<ReferenceGraph.VisitControl>

Enclosing interface:

ReferenceGraph

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

Controls the subsequent visit actions during a traversal of the ReferenceGraph. This is the type returned by ReferenceGraph.Visitor.visit(org.azyva.dragom.reference.ReferenceGraph, org.azyva.dragom.reference.ReferencePath, java.util.EnumSet<org.azyva.dragom.reference.ReferenceGraph.VisitAction>).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Aborts the traversal.
CONTINUE Continue.
SKIP_CHILDREN Skip the children and continue.
SKIP_CURRENT_ROOT Skip the current root ModuleVersion and continue with the next one, if any.

Method Summary

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

CONTINUE

public static final ReferenceGraph.VisitControl CONTINUE

Continue.

ABORT

public static final ReferenceGraph.VisitControl ABORT

Aborts the traversal.

SKIP_CHILDREN

public static final ReferenceGraph.VisitControl SKIP_CHILDREN

Skip the children and continue.

Not valid when ReferenceGraph.VisitAction.STEP_OUT.

Not valid when ReferenceGraph.traverseReferenceGraph(org.azyva.dragom.model.ModuleVersion, boolean, org.azyva.dragom.reference.ReferenceGraph.ReentryMode, org.azyva.dragom.reference.ReferenceGraph.Visitor) is called with indDepthFirst and ReferenceGraph.VisitAction.VISIT.

Not valid when ReferenceGraph.visitLeafModuleVersionReferencePaths(org.azyva.dragom.model.ModuleVersion, org.azyva.dragom.reference.ReferenceGraph.Visitor).

SKIP_CURRENT_ROOT

public static final ReferenceGraph.VisitControl SKIP_CURRENT_ROOT

Skip the current root ModuleVersion and continue with the next one, if any.

Not valid when ReferenceGraph.visitLeafModuleVersionReferencePaths(org.azyva.dragom.model.ModuleVersion, org.azyva.dragom.reference.ReferenceGraph.Visitor).

Method Detail

values

public static ReferenceGraph.VisitControl[] 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.VisitControl c : ReferenceGraph.VisitControl.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.VisitControl 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