Package com.alachisoft.ncache.runtime.events

Enum EventType

java.lang.Object

java.lang.Enum<EventType>

com.alachisoft.ncache.runtime.events.EventType

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

NCache provides an EventType enum which specifies the type of event to be registered by the user. Event types are specified at the time of notification registration.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ItemAdded	User receives a notification when an item is added in the cache.
ItemRemoved	User receives a notification when an item is removed from the cache.
ItemUpdated	User receives a notification when an item is updated in the cache.

Method Summary

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

ItemAdded

public static final EventType ItemAdded

User receives a notification when an item is added in the cache.

ItemUpdated

public static final EventType ItemUpdated

User receives a notification when an item is updated in the cache.

ItemRemoved

public static final EventType ItemRemoved

User receives a notification when an item is removed from the cache.

Method Detail

values

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

Returns:

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

valueOf

public static EventType 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 an array index.

Returns:

Enum constant index.

getEventType

public static EventType getEventType(int index)

Retreives the Enum constant of the specified value, if exists.

Parameters:

index - Enum constant index.

Returns:

Enum constant.