Package com.tailf.maapi

Enum Class XPathNodeIterateResultFlag

Object

Enum<XPathNodeIterateResultFlag>

com.tailf.maapi.XPathNodeIterateResultFlag

All Implemented Interfaces:

Serializable, Comparable<XPathNodeIterateResultFlag>, Constable

public enum XPathNodeIterateResultFlag
extends Enum<XPathNodeIterateResultFlag>

The result(ConfObject[],ConfValue,Object) method should return any of the following two 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 result method should return ITER_CONTINUE when iteration should continue with the next resulting node (if any).
ITER_STOP	The result method should return ITER_STOP when no more iteration should be done.

Method Summary

Modifier and Type	Method	Description
int	getValue()
static XPathNodeIterateResultFlag	valueOf(int i)	Returns the enum constant of this class with the specified name.
static XPathNodeIterateResultFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XPathNodeIterateResultFlag[]	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 XPathNodeIterateResultFlag ITER_STOP

The result method should return ITER_STOP when no more iteration should be done.

ITER_CONTINUE

public static final XPathNodeIterateResultFlag ITER_CONTINUE

The result method should return ITER_CONTINUE when iteration should continue with the next resulting node (if any).

Method Details

values

public static XPathNodeIterateResultFlag[] 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 XPathNodeIterateResultFlag 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 XPathNodeIterateResultFlag 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