Package com.tailf.conf

Enum Class ConfIterateResultFlag

Object

Enum<ConfIterateResultFlag>

com.tailf.conf.ConfIterateResultFlag

All Implemented Interfaces:

Serializable, Comparable<ConfIterateResultFlag>, Constable

public enum ConfIterateResultFlag
extends Enum<ConfIterateResultFlag>

flags us by DiffIterate interface The iterate() method should return any of the following constants

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ITER_CONTINUE	The iterate() method should return ITER_CONTINUE when iteration should continue with the nodes siblings.
ITER_RECURSE	The iterate() method should return ITER_RECURSE when iteration should continue on all the nodes children.
ITER_STOP	The iterate() method should return ITER_STOP when no more iteration should be done.
ITER_SUSPEND

Method Summary

Modifier and Type	Method	Description
int	getValue()
static ConfIterateResultFlag	valueOf(int i)	Returns the enum constant of this class with the specified name.
static ConfIterateResultFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConfIterateResultFlag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ITER_STOP

public static final ConfIterateResultFlag ITER_STOP

The iterate() method should return ITER_STOP when no more iteration should be done.

ITER_RECURSE

public static final ConfIterateResultFlag ITER_RECURSE

The iterate() method should return ITER_RECURSE when iteration should continue on all the nodes children. (if any)

ITER_CONTINUE

public static final ConfIterateResultFlag ITER_CONTINUE

The iterate() method should return ITER_CONTINUE when iteration should continue with the nodes siblings. (if any)

ITER_SUSPEND

public static final ConfIterateResultFlag ITER_SUSPEND

Method Details

values

public static ConfIterateResultFlag[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ConfIterateResultFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

valueOf

public static ConfIterateResultFlag valueOf(int i)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

i - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null