com.tailf.conf

Enum ConfIterateResultFlag

Object

Enum<ConfIterateResultFlag>

com.tailf.conf.ConfIterateResultFlag

All Implemented Interfaces:

Serializable, Comparable<ConfIterateResultFlag>

public enum ConfIterateResultFlag
extends Enum<ConfIterateResultFlag>

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
int	getValue()
static ConfIterateResultFlag	valueOf(int i)
static ConfIterateResultFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConfIterateResultFlag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

valueOf

public static ConfIterateResultFlag valueOf(int i)