org.apache.shindig.gadgets.rewrite

Enum DomWalker.Visitor.VisitStatus

java.lang.Object

java.lang.Enum<DomWalker.Visitor.VisitStatus>

org.apache.shindig.gadgets.rewrite.DomWalker.Visitor.VisitStatus

All Implemented Interfaces:

Serializable, Comparable<DomWalker.Visitor.VisitStatus>

Enclosing interface:

DomWalker.Visitor

public static enum DomWalker.Visitor.VisitStatus
extends Enum<DomWalker.Visitor.VisitStatus>

Returned by the visit(Gadget, Node) method, signaling: BYPASS = Visitor doesn't care about the node. MODIFY = Visitor has modified the node. RESERVE_NODE = Visitor reserves exactly the node passed. No other Visitor will visit the node. RESERVE_TREE = Visitor reserves the node passed and all its descendants No other Visitor will visit them. Visitors are expected to be well-behaved in that they do not modify unreserved nodes: that is, in revisit(...) they do not access adjacent, parent, etc. nodes and modify them. visit(...) may return MODIFY to indicate a modification of the given node. Other append and delete operations are acceptable but only in revisit(). Reservations are supported in order to support "batched" lookups relating to a similar set of data retrieved from a backend.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYPASS
MODIFY
RESERVE_NODE
RESERVE_TREE

Method Summary

Methods

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

BYPASS

public static final DomWalker.Visitor.VisitStatus BYPASS

MODIFY

public static final DomWalker.Visitor.VisitStatus MODIFY

RESERVE_NODE

public static final DomWalker.Visitor.VisitStatus RESERVE_NODE

RESERVE_TREE

public static final DomWalker.Visitor.VisitStatus RESERVE_TREE

Method Detail

values

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

Returns:

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

valueOf

public static DomWalker.Visitor.VisitStatus 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