graphql.util

Enum TraversalControl

java.lang.Object

java.lang.Enum<TraversalControl>

graphql.util.TraversalControl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TraversalControl>

@PublicApi
public enum TraversalControl
extends java.lang.Enum<TraversalControl>

Special traversal control values

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT When returned from a Visitor's method, indicates skipping traversal of a subtree.
CONTINUE When returned the traversal will continue as planned.
QUIT When returned from a Visitor's method, indicates exiting the traversal

Method Summary

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

CONTINUE

public static final TraversalControl CONTINUE

When returned the traversal will continue as planned.

QUIT

public static final TraversalControl QUIT

When returned from a Visitor's method, indicates exiting the traversal

ABORT

public static final TraversalControl ABORT

When returned from a Visitor's method, indicates skipping traversal of a subtree. Not allowed to be returned from 'leave' or 'backRef' because it doesn't make sense.

Method Detail

values

public static 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 (TraversalControl c : 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 TraversalControl valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null