Package com.alachisoft.ncache.runtime.events

Class DataStructureEventArg

java.lang.Object

com.alachisoft.ncache.runtime.events.DataStructureEventArg

public class DataStructureEventArg
extends java.lang.Object

This object is received when a collection event is raised and delegate DataStructureDataChangeListener.onDataStructureChanged(java.lang.String, com.alachisoft.ncache.runtime.events.DataStructureEventArg) is executed. This class contains necessary information to identify the event and perform necessary actions accordingly.

Constructor Summary

Constructors

Constructor	Description
DataStructureEventArg(java.lang.String cacheName, EventType eventType, DistributedDataStructure dataType, java.lang.Object dataTypeItem, java.lang.Object oldDataTypeItem)	Constructor that initializes all the properties of this class.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCacheName()	Gets the name of cache the collection event is registered against.
java.lang.Object	getCollectionItem()	Gets current the collection item.
DistributedDataStructure	getCollectionType()	The type of collection, pertaining to DistributedDataStructure,returned on fire of collection event.
EventType	getEventType()	Gets the type of the event.
java.lang.Object	getOldCollectionItem()	Gets the previous value of the collection item.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataStructureEventArg

public DataStructureEventArg(java.lang.String cacheName,
                             EventType eventType,
                             DistributedDataStructure dataType,
                             java.lang.Object dataTypeItem,
                             java.lang.Object oldDataTypeItem)

Constructor that initializes all the properties of this class.

Parameters:

cacheName - Name of cache the collection event is to be registered against.

eventType - Event types the event is to be registered against.

dataType - The type of collection, pertaining to DistributedDataStructureType, to be returned on fire of collection event.

dataTypeItem - Value of collection item if the respective filter is set.

oldDataTypeItem - Old value of collection item if the respective filter is set.

Method Detail

getCacheName

public final java.lang.String getCacheName()

Gets the name of cache the collection event is registered against.

Returns:

The name of cache the collection event is registered against.

getCollectionItem

public final java.lang.Object getCollectionItem()

Gets current the collection item.

Returns:

The current collection item.

getOldCollectionItem

public final java.lang.Object getOldCollectionItem()

Gets the previous value of the collection item. This is only populated in case of update operation.

Returns:

The previous value of the collection item.

getEventType

public final EventType getEventType()

Gets the type of the event.

Returns:

The EventType enum.

getCollectionType

public final DistributedDataStructure getCollectionType()

The type of collection, pertaining to DistributedDataStructure,returned on fire of collection event.

Returns:

The DistributedDataStructure enum.