com.helger.commons.hierarchy.visit

Enum EHierarchyVisitorReturn

java.lang.Object

java.lang.Enum<EHierarchyVisitorReturn>

com.helger.commons.hierarchy.visit.EHierarchyVisitorReturn

All Implemented Interfaces:

Serializable, Comparable<EHierarchyVisitorReturn>

public enum EHierarchyVisitorReturn
extends Enum<EHierarchyVisitorReturn>

Return value for hierarchy iteration.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUE Continue with the next element.
STOP_ITERATION Stop the iteration completely and immediately.
USE_NEXT_SIBLING Skip the child elements of the current element and go to the next sibling.
USE_PARENTS_NEXT_SIBLING Skip the child elements and all siblings of the current content element and go to the parent element's sibling.

Method Summary

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

Continue with the next element. This may either be the first child element or the next sibling.

USE_NEXT_SIBLING

public static final EHierarchyVisitorReturn USE_NEXT_SIBLING

Skip the child elements of the current element and go to the next sibling. This can only be returned before children are iterated.
Important: this enum constant is never explicitly queried but it is implicitly used!

USE_PARENTS_NEXT_SIBLING

public static final EHierarchyVisitorReturn USE_PARENTS_NEXT_SIBLING

Skip the child elements and all siblings of the current content element and go to the parent element's sibling.

STOP_ITERATION

public static final EHierarchyVisitorReturn STOP_ITERATION

Stop the iteration completely and immediately.

Method Detail

values

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

Returns:

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

valueOf

public static EHierarchyVisitorReturn 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

isContinue

public boolean isContinue()