Package com.technia.dsx.threedspace.structure

Enum Class VisitResult

java.lang.Object

java.lang.Enum<VisitResult>

com.technia.dsx.threedspace.structure.VisitResult

All Implemented Interfaces:

com.technia.dsx.EnumType, Serializable, Comparable<VisitResult>, Constable

public enum VisitResult
extends Enum<VisitResult>
implements com.technia.dsx.EnumType

Controls the traversal behavior when visiting structure elements.

This enum is returned by StructureVisitor visit methods to control how the structure traversal proceeds.

Since:

2023-04-25

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTINUE	Continue normal traversal to siblings and children.
SKIP_SIBLINGS	Skip remaining siblings but continue with children of the current node.
SKIP_SUBTREE	Skip the subtree (children) of the current node but continue with siblings.
TERMINATE	Terminate the entire traversal.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.technia.dsx.EnumType

getConstantAliases

Enum Constant Details

CONTINUE

public static final VisitResult CONTINUE

Continue normal traversal to siblings and children.

SKIP_SIBLINGS

public static final VisitResult SKIP_SIBLINGS

Skip remaining siblings but continue with children of the current node.

SKIP_SUBTREE

public static final VisitResult SKIP_SUBTREE

Skip the subtree (children) of the current node but continue with siblings.

TERMINATE

public static final VisitResult TERMINATE

Terminate the entire traversal.

Method Details

values

public static VisitResult[] values()

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

Returns:

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

valueOf

public static VisitResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null