com.google.template.soy.soytree

Enum SoyTreeUtils.VisitDirective

java.lang.Object

java.lang.Enum<SoyTreeUtils.VisitDirective>

com.google.template.soy.soytree.SoyTreeUtils.VisitDirective

All Implemented Interfaces:

Serializable, Comparable<SoyTreeUtils.VisitDirective>

Enclosing class:

SoyTreeUtils

public static enum SoyTreeUtils.VisitDirective
extends Enum<SoyTreeUtils.VisitDirective>

An enum that allows a {#visitAllNodes} visitor to control how the AST is traversed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT This means that the whole visit operation should be abrubptly halted.
CONTINUE This means that traversal should continue as normal.
SKIP_CHILDREN This means that the childrent of the current node should not be visited, but traversal should continue.

Method Summary

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

SKIP_CHILDREN

public static final SoyTreeUtils.VisitDirective SKIP_CHILDREN

This means that the childrent of the current node should not be visited, but traversal should continue.

ABORT

public static final SoyTreeUtils.VisitDirective ABORT

This means that the whole visit operation should be abrubptly halted.

CONTINUE

public static final SoyTreeUtils.VisitDirective CONTINUE

This means that traversal should continue as normal.

Method Detail

values

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

Returns:

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

valueOf

public static SoyTreeUtils.VisitDirective 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