Package com.alachisoft.ncache.runtime.dependencies

Enum KeyDependencyType

java.lang.Object

java.lang.Enum<KeyDependencyType>

com.alachisoft.ncache.runtime.dependencies.KeyDependencyType

public enum KeyDependencyType
extends java.lang.Enum<KeyDependencyType>

An enumeration that defines the operation upon which key dependency is to be triggered.

Enum Constant Summary

Enum Constants

Enum Constant	Description
RemoveOnly	Trigger key dependency when a remove operation takes place on the cache item.
UpdateOrRemove	Trigger key dependency when an update or remove operation takes place on the cache item.

Method Summary

Modifier and Type	Method	Description
static KeyDependencyType	forValue(int value)	retreives the enum constant of the specified value, if exists.
int	getValue()	Order is important in enums.By using getValue() method, each enum constant index can be found, just like array index.
static KeyDependencyType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static KeyDependencyType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UpdateOrRemove

public static final KeyDependencyType UpdateOrRemove

Trigger key dependency when an update or remove operation takes place on the cache item. This is the default value.

RemoveOnly

public static final KeyDependencyType RemoveOnly

Trigger key dependency when a remove operation takes place on the cache item.

Method Detail

values

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

Returns:

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

valueOf

public static KeyDependencyType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Order is important in enums.By using getValue() method, each enum constant index can be found, just like array index.

Returns:

enum constant index

forValue

public static KeyDependencyType forValue(int value)

retreives the enum constant of the specified value, if exists.

Parameters:

value - enum constant index

Returns:

enum constant