com.io7m.jspatial.api

Enum TreeVisitResult

java.lang.Object

java.lang.Enum<TreeVisitResult>

com.io7m.jspatial.api.TreeVisitResult

All Implemented Interfaces:

Serializable, Comparable<TreeVisitResult>

public enum TreeVisitResult
extends Enum<TreeVisitResult>

The result of traversing a tree.

Since:

3.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
RESULT_CONTINUE Continue the traversal.
RESULT_TERMINATE Terminate the traversal.

Method Summary

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

RESULT_CONTINUE

public static final TreeVisitResult RESULT_CONTINUE

Continue the traversal.

RESULT_TERMINATE

public static final TreeVisitResult RESULT_TERMINATE

Terminate the traversal.

Method Detail

values

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

Returns:

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

valueOf

public static TreeVisitResult 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