org.xwiki.gwt.dom.client.filter
Enum NodeFilter.Action

java.lang.Object
  java.lang.Enum<NodeFilter.Action>
      org.xwiki.gwt.dom.client.filter.NodeFilter.Action

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NodeFilter.Action>

Enclosing interface:

NodeFilter

public static enum NodeFilter.Action
extends java.lang.Enum<NodeFilter.Action>

The action that should be taken on the filtered node.

Enum Constant Summary

ACCEPT
Accept the node.

REJECT
Reject the node.

SKIP
Skip this single node.

Method Summary

static NodeFilter.Action	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NodeFilter.Action[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACCEPT

public static final NodeFilter.Action ACCEPT

Accept the node. Note iterators should return this node.

REJECT

public static final NodeFilter.Action REJECT

Reject the node. Tree iterators should reject the children of this node too. Node list iterators should consider this equivalent to #FILTER_SKIP.

SKIP

public static final NodeFilter.Action SKIP

Skip this single node. Both tree and list iterators will still consider the children of this node.

Method Detail

values

public static final NodeFilter.Action[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(NodeFilter.Action c : NodeFilter.Action.values())
        System.out.println(c);

Returns:

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

valueOf

public static NodeFilter.Action 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