org.jboss.cache

Enum AbstractNode.NodeFlags

java.lang.Object

java.lang.Enum<AbstractNode.NodeFlags>

org.jboss.cache.AbstractNode.NodeFlags

All Implemented Interfaces:

Serializable, Comparable<AbstractNode.NodeFlags>

Enclosing class:

AbstractNode<K,V>

public static enum AbstractNode.NodeFlags
extends Enum<AbstractNode.NodeFlags>

These flags were originally stored as booleans on the UnversionedNode class. They have been replaced with an enum and an EnumSet, which is much more space-efficient for very little cost in lookups.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILDREN_LOADED All children are loaded from the cache loader if this flag is present.
CHILDREN_MODIFIED_IN_WORKSPACE Specific to Optimistic Locking Workspace nodes - set if a node has added or removed children in a workspace.
CREATED_IN_WORKSPACE Specific to Optimistic Locking Workspace nodes - set if a node has been created in a workspace.
DATA_LOADED Data is loaded from the cache loader if this flag is present.
LOCK_FOR_CHILD_INSERT_REMOVE Node is write-locked when children are added or removed if this flag is enabled.
MODIFIED_IN_WORKSPACE Specific to Optimistic Locking Workspace nodes - set if a node has been modified in a workspace.
REMOVED Node has been removed.
RESIDENT NOde is resident and excluded from evictions
RESURRECTED_IN_WORKSPACE Specific to Optimistic Locking Workspace nodes - set if a node has been resurrected in a workspace.
VALID Node is valid if this flag is present.
VERSIONING_IMPLICIT Specific to Optimistic Locking Workspace nodes - set if an implicit version is associated with this node.

Field Summary

Fields

Modifier and Type	Field and Description
protected short	mask

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHILDREN_LOADED

public static final AbstractNode.NodeFlags CHILDREN_LOADED

All children are loaded from the cache loader if this flag is present.

DATA_LOADED

public static final AbstractNode.NodeFlags DATA_LOADED

Data is loaded from the cache loader if this flag is present.

LOCK_FOR_CHILD_INSERT_REMOVE

public static final AbstractNode.NodeFlags LOCK_FOR_CHILD_INSERT_REMOVE

Node is write-locked when children are added or removed if this flag is enabled.

VALID

public static final AbstractNode.NodeFlags VALID

Node is valid if this flag is present.

REMOVED

public static final AbstractNode.NodeFlags REMOVED

Node has been removed.

RESIDENT

public static final AbstractNode.NodeFlags RESIDENT

NOde is resident and excluded from evictions

MODIFIED_IN_WORKSPACE

public static final AbstractNode.NodeFlags MODIFIED_IN_WORKSPACE

Specific to Optimistic Locking Workspace nodes - set if a node has been modified in a workspace.

CREATED_IN_WORKSPACE

public static final AbstractNode.NodeFlags CREATED_IN_WORKSPACE

Specific to Optimistic Locking Workspace nodes - set if a node has been created in a workspace.

CHILDREN_MODIFIED_IN_WORKSPACE

public static final AbstractNode.NodeFlags CHILDREN_MODIFIED_IN_WORKSPACE

Specific to Optimistic Locking Workspace nodes - set if a node has added or removed children in a workspace.

VERSIONING_IMPLICIT

public static final AbstractNode.NodeFlags VERSIONING_IMPLICIT

Specific to Optimistic Locking Workspace nodes - set if an implicit version is associated with this node.

RESURRECTED_IN_WORKSPACE

public static final AbstractNode.NodeFlags RESURRECTED_IN_WORKSPACE

Specific to Optimistic Locking Workspace nodes - set if a node has been resurrected in a workspace.

Field Detail

mask

protected final short mask

Method Detail

values

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

Returns:

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

valueOf

public static AbstractNode.NodeFlags 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