Package com.tailf.conf

Enum Class ConfIterateFlags

Object

Enum<ConfIterateFlags>

com.tailf.conf.ConfIterateFlags

All Implemented Interfaces:

Serializable, Comparable<ConfIterateFlags>, Constable

public enum ConfIterateFlags
extends Enum<ConfIterateFlags>

Enumeration flags us by CdbSubscription.diffIterate(int,CdbDiffIterate,EnumSet,Object) to control the behavior of iterate over changes made in CDB data.

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_WANT_ANCESTOR_DELETE	Control if the deleted of a ancestor will trigger a subscription iteration.
ITER_WANT_ATTR	This is flag that only has meaning in the maapi case.
ITER_WANT_CLI_STR
ITER_WANT_LEAF_FIRST_ORDER
ITER_WANT_LEAF_LAST_ORDER
ITER_WANT_PREV	Include the previous value for modification of a leaf/leaf-list value.
ITER_WANT_REVERSE
ITER_WANT_SCHEMA_ORDER

Method Summary

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

public static final ConfIterateFlags ITER_WANT_PREV

Include the previous value for modification of a leaf/leaf-list value. If the flags is provided to CdbSubscription.diffIterate(int,CdbDiffIterate,EnumSet,Object) The old value is supplied to the call to CdbDiffIterate.iterate(ConfObject[], DiffIterateOperFlag, ConfObject,ConfObject,Object) if a value have changed.

For operational data subscriptions, the ITER_WANT_PREV flag is ignored, and old value is always null - there is no equivalent to CdbDBType.CDB_PRE_COMMIT_RUNNING that holds "old" operational data method. This option is default in CdbSubscription.diffIterate(int, CdbDiffIterate) which means that the flag needs not to be passed explicitly.

ITER_WANT_ANCESTOR_DELETE

public static final ConfIterateFlags ITER_WANT_ANCESTOR_DELETE

Control if the deleted of a ancestor will trigger a subscription iteration.

The flag ITER_WANT_ANCESTOR_DELETE is passed to diffIterate method which specifies that a subscription should be triggered because an ancestor was deleted subscription will also generate a call to iterate, and in this case kp will be the path that was actually deleted. This option is not default in CdbSubscription.diffIterate(int, CdbDiffIterate) which means that the flag needs to be passed explicitly.

ITER_WANT_ATTR

public static final ConfIterateFlags ITER_WANT_ATTR

This is flag that only has meaning in the maapi case. If set, the iteration will also go over attribute values. In such cases the DiffIterateOperFlag will be set to DiffIterateOperFlag.MOP_ATTR_SET in the iterator and the new and old values will be of type ConfAttributeValue

ITER_WANT_CLI_STR

public static final ConfIterateFlags ITER_WANT_CLI_STR

ITER_WANT_SCHEMA_ORDER

public static final ConfIterateFlags ITER_WANT_SCHEMA_ORDER

ITER_WANT_LEAF_FIRST_ORDER

public static final ConfIterateFlags ITER_WANT_LEAF_FIRST_ORDER

ITER_WANT_LEAF_LAST_ORDER

public static final ConfIterateFlags ITER_WANT_LEAF_LAST_ORDER

ITER_WANT_REVERSE

public static final ConfIterateFlags ITER_WANT_REVERSE

Method Details

values

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