Enum TreeVisit.ETreeVisitResult

java.lang.Object

java.lang.Enum<TreeVisit.ETreeVisitResult>

de.xima.fc.common.tree.TreeVisit.ETreeVisitResult

All Implemented Interfaces:

Serializable, Comparable<TreeVisit.ETreeVisitResult>

Enclosing class:

TreeVisit

public static enum TreeVisit.ETreeVisitResult
extends Enum<TreeVisit.ETreeVisitResult>

Indicates how to proceed with a tree visit, see TreeVisit and TreeVisit.ITreeVisitor.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROCEED	Proceed with the tree visit normally.
QUIT	Stop visiting the tree entirely.
SKIP_NODE	Do not visit this node, but visit children.
SKIP_NODE_AND_SUB_TREE	Do not visit this node and skip all children as well.
SKIP_SUB_TREE	Visit this node, but skip all children.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PROCEED

public static final TreeVisit.ETreeVisitResult PROCEED

Proceed with the tree visit normally.

SKIP_NODE

public static final TreeVisit.ETreeVisitResult SKIP_NODE

Do not visit this node, but visit children. exit will still be called.

SKIP_SUB_TREE

public static final TreeVisit.ETreeVisitResult SKIP_SUB_TREE

Visit this node, but skip all children.

SKIP_NODE_AND_SUB_TREE

public static final TreeVisit.ETreeVisitResult SKIP_NODE_AND_SUB_TREE

Do not visit this node and skip all children as well.

QUIT

public static final TreeVisit.ETreeVisitResult QUIT

Stop visiting the tree entirely. exit will still be called.

Method Details

values

public static TreeVisit.ETreeVisitResult[] values()

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

Returns:

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

valueOf

public static TreeVisit.ETreeVisitResult 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