org.omnaest.utils.structure.hierarchy.tree
Enum TreeNavigator.TreeNodeVisitor.TraversalControl

java.lang.Object
  java.lang.Enum<TreeNavigator.TreeNodeVisitor.TraversalControl>
      org.omnaest.utils.structure.hierarchy.tree.TreeNavigator.TreeNodeVisitor.TraversalControl

All Implemented Interfaces:

Serializable, Comparable<TreeNavigator.TreeNodeVisitor.TraversalControl>

Enclosing interface:

TreeNavigator.TreeNodeVisitor<T extends Tree<?,TN>,TN extends TreeNode>

public static enum TreeNavigator.TreeNodeVisitor.TraversalControl
extends Enum<TreeNavigator.TreeNodeVisitor.TraversalControl>

Controls the ongoing traversal of the TreeNavigator

Author:

Omnaest

Enum Constant Summary

CANCEL_TRAVERSAL
Cancels the traversal for the current TreeNavigator.TreeNodeVisitor.

GO_ON
Goes on with an unchanged TreeNavigator.TreeNodeVisitor.TraversalConfiguration

GO_ON_EXCLUDE_ALREADY_TRAVERSED_NODES
Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() permanently to false

GO_ON_EXCLUDE_CHILDREN
Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to false

GO_ON_EXCLUDE_CHILDREN_AND_ALREADY_TRAVERSED_NODES
Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to false and the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() to false

GO_ON_EXCLUDE_CHILDREN_AND_INCLUDE_ALREADY_TRAVERSED_NODES
Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to false and the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() to true

GO_ON_INCLUDE_ALREADY_TRAVERSED_NODES
Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() permanently to true

GO_ON_INCLUDE_CHILDREN
Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to true

GO_ON_INCLUDE_CHILDREN_AND_ALREADY_TRAVERSED_NODES
Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to true and the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() to true

GO_ON_INCLUDE_CHILDREN_AND_EXCLUDE_ALREADY_TRAVERSED_NODES
Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to true and the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() to false

SKIP_CHILDREN
Skips all children only for the current node

SKIP_CHILDREN_AND_FURTHER_SIBLINGS
Skips all children and further siblings of the current node

SKIP_FURTHER_SIBLINGS
Skips further siblings of the current node

Method Summary

static TreeNavigator.TreeNodeVisitor.TraversalControl	valueOf(String name) Returns the enum constant of this type with the specified name.
static TreeNavigator.TreeNodeVisitor.TraversalControl[]	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

GO_ON

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON

Goes on with an unchanged TreeNavigator.TreeNodeVisitor.TraversalConfiguration

GO_ON_INCLUDE_ALREADY_TRAVERSED_NODES

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON_INCLUDE_ALREADY_TRAVERSED_NODES

Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() permanently to true

GO_ON_EXCLUDE_ALREADY_TRAVERSED_NODES

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON_EXCLUDE_ALREADY_TRAVERSED_NODES

Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() permanently to false

GO_ON_INCLUDE_CHILDREN

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON_INCLUDE_CHILDREN

Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to true

GO_ON_EXCLUDE_CHILDREN

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON_EXCLUDE_CHILDREN

Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to false

GO_ON_INCLUDE_CHILDREN_AND_ALREADY_TRAVERSED_NODES

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON_INCLUDE_CHILDREN_AND_ALREADY_TRAVERSED_NODES

Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to true and the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() to true

GO_ON_EXCLUDE_CHILDREN_AND_ALREADY_TRAVERSED_NODES

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON_EXCLUDE_CHILDREN_AND_ALREADY_TRAVERSED_NODES

Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to false and the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() to false

GO_ON_EXCLUDE_CHILDREN_AND_INCLUDE_ALREADY_TRAVERSED_NODES

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON_EXCLUDE_CHILDREN_AND_INCLUDE_ALREADY_TRAVERSED_NODES

Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to false and the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() to true

GO_ON_INCLUDE_CHILDREN_AND_EXCLUDE_ALREADY_TRAVERSED_NODES

public static final TreeNavigator.TreeNodeVisitor.TraversalControl GO_ON_INCLUDE_CHILDREN_AND_EXCLUDE_ALREADY_TRAVERSED_NODES

Changes the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingChildren() permanently to true and the TreeNavigator.TreeNodeVisitor.TraversalConfiguration.isIncludingAlreadyTraversedNodes() to false

SKIP_CHILDREN

public static final TreeNavigator.TreeNodeVisitor.TraversalControl SKIP_CHILDREN

Skips all children only for the current node

SKIP_FURTHER_SIBLINGS

public static final TreeNavigator.TreeNodeVisitor.TraversalControl SKIP_FURTHER_SIBLINGS

Skips further siblings of the current node

SKIP_CHILDREN_AND_FURTHER_SIBLINGS

public static final TreeNavigator.TreeNodeVisitor.TraversalControl SKIP_CHILDREN_AND_FURTHER_SIBLINGS

Skips all children and further siblings of the current node

CANCEL_TRAVERSAL

public static final TreeNavigator.TreeNodeVisitor.TraversalControl CANCEL_TRAVERSAL

Cancels the traversal for the current TreeNavigator.TreeNodeVisitor. If multiple TreeNavigator.TreeNodeVisitors are specified the others are unaffected. Each TreeNavigator.TreeNodeVisitor has to cancel the traversal for itself.

Method Detail

values

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

Returns:

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

valueOf

public static TreeNavigator.TreeNodeVisitor.TraversalControl 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