Package com.alachisoft.ncache.runtime.events

Enum DataTypeEventDataFilter

java.lang.Object

java.lang.Enum<DataTypeEventDataFilter>

com.alachisoft.ncache.runtime.events.DataTypeEventDataFilter

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

This enum is to describe when registering a collection event, upon raise how much data is retrieved from cache when the event is raised. Only one value can be set.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Data	This specifies that item of collection is required when an event notification is raised.
None	This specifies that no data or meta data is required when an event notification is raised.

Method Summary

Modifier and Type	Method	Description
static DataTypeEventDataFilter	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 DataTypeEventDataFilter	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static DataTypeEventDataFilter[]	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

None

public static final DataTypeEventDataFilter None

This specifies that no data or meta data is required when an event notification is raised.

Data

public static final DataTypeEventDataFilter Data

This specifies that item of collection is required when an event notification is raised.

Method Detail

values

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

Returns:

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

valueOf

public static DataTypeEventDataFilter 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

forValue

public static DataTypeEventDataFilter forValue(int value)

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

Parameters:

value - enum constant index

Returns:

enum constant

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