Package com.tailf.maapi

Enum Class MaapiFlag

Object

Enum<MaapiFlag>

com.tailf.maapi.MaapiFlag

All Implemented Interfaces:

Serializable, Comparable<MaapiFlag>, Constable

public enum MaapiFlag
extends Enum<MaapiFlag>

Flags used by Maapi.setFlags(int,EnumSet) method to control read/write sessions.

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
CONFIG_ONLY	This flag will make the Maapi.getXxx() method return config nodes only.
DELAYED_WHEN	This flag only takes effect when used in Maapi.startTransFlags(int,int,int,EnumSet) calls and is only meaningful when applied to an read-write transaction.
HIDE_ALL_HIDEGROUPS	This flag only takes effect when used in Maapi.startTransFlags(int,int,int,EnumSet) calls.
HIDE_INACTIVE	This flag only takes effect when used in Maapi.startTransFlags(int,int,int,EnumSet) calls and only when starting a read-only transaction.
HINT_BULK	This flag tells the server that we will be reading substantial amounts of data.
NO_DEFAULTS	This flag specifies that we want to be informed when we read leafs with default values that have not had a value set.
SKIP_SUBSCRIBERS	This flag only takes effect when used in Maapi.startTransFlags(int,int,int,EnumSet) calls.

Method Summary

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

HINT_BULK

public static final MaapiFlag HINT_BULK

This flag tells the server that we will be reading substantial amounts of data.

The affect of setting this has the effect that the DpDataCallback.getObject(DpTrans,ConfObject[]) and DpDataCallback.iterator(DpTrans,ConfObject[]), DpDataCallback.getIteratorKey(DpTrans,ConfObject[],Object) callbacks (if available) are used towards external data providers when we call Maapi.getElem(int,String,Object...) etc and Maapi.getNext(MaapiCursor).

The Maapi.getObject(int,String,Object...) method always operates as if this flag was set.

NO_DEFAULTS

public static final MaapiFlag NO_DEFAULTS

This flag specifies that we want to be informed when we read leafs with default values that have not had a value set.

This is indicated by the returned value being of class ConfDefault (type J_DEFAULT) instead of the actual value. The default value for such leafs can be obtained from the Maapi.loadSchemas() tree provided by the library.

CONFIG_ONLY

public static final MaapiFlag CONFIG_ONLY

This flag will make the Maapi.getXxx() method return config nodes only.

if we attempt to read operational data, it will be treated as if the nodes did not exist. This is mainly useful in conjunction with Maapi.getObject(int,String,Object...) and list entries or containers that have both config and operational data (the operational data nodes in the returned array will be of class ConfNoExists (type J_NOEXISTS), but the other functions also obey the flag.

HIDE_INACTIVE

public static final MaapiFlag HIDE_INACTIVE

This flag only takes effect when used in Maapi.startTransFlags(int,int,int,EnumSet) calls and only when starting a read-only transaction. It will hide configuration data that has the ConfAttributeType.INACTIVE attribute set, i.e. it will appear as if that data does not exist.

DELAYED_WHEN

public static final MaapiFlag DELAYED_WHEN

This flag only takes effect when used in Maapi.startTransFlags(int,int,int,EnumSet) calls and is only meaningful when applied to an read-write transaction. It will cause "delayed when" mode to be enabled from the beginning of the transaction. See Maapi.setDelayedWhen(int, boolean) for more information about the "delayed when" mode

HIDE_ALL_HIDEGROUPS

public static final MaapiFlag HIDE_ALL_HIDEGROUPS

This flag only takes effect when used in Maapi.startTransFlags(int,int,int,EnumSet) calls. It will hide all nodes with tailf:hidden statement from the dry-run result. See Maapi.applyTransParams(int, boolean, CommitParams) for more information about the dry-run.

SKIP_SUBSCRIBERS

public static final MaapiFlag SKIP_SUBSCRIBERS

This flag only takes effect when used in Maapi.startTransFlags(int,int,int,EnumSet) calls. It will disable subscribers for the given transaction, use with caution.

Method Details

values

public static MaapiFlag[] 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 MaapiFlag 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()