com.puppycrawl.tools.checkstyle.xpath.iterators

Enum DescendantIterator.StartWith

java.lang.Object

java.lang.Enum<DescendantIterator.StartWith>

com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator.StartWith

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DescendantIterator.StartWith>

Enclosing class:

DescendantIterator

public static enum DescendantIterator.StartWith
extends java.lang.Enum<DescendantIterator.StartWith>

Enum defines starting node for iterator.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILDREN Omit current node and start with child nodes.
CURRENT_NODE Start with current node.

Method Summary

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

CURRENT_NODE

public static final DescendantIterator.StartWith CURRENT_NODE

Start with current node.

CHILDREN

public static final DescendantIterator.StartWith CHILDREN

Omit current node and start with child nodes.

Method Detail

values

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

Returns:

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

valueOf

public static DescendantIterator.StartWith 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