Package com.alachisoft.ncache.runtime.events

Enum EventDataFilter

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EventDataFilter>
    public enum EventDataFilter
extends java.lang.Enum<EventDataFilter>
    NCache provides an enum EventDataFilter to specify how much data should be retrieved from cache when a notification is raised. This is specified when user registers a notification.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DataWithMetadata
      This specifies that the value of the cache item is required along with all the meta data when an event notification is raised.
      Metadata
      This specifies that only meta data of cache item is required when an event notification is raised.Meta data includes in information like groups, subgroups, cacheItemPriority, item version etc.
      None
      This specifies that no data or meta data is required when an event notification is raised.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static EventDataFilter 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 EventDataFilter valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EventDataFilter[] 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 EventDataFilter None
        This specifies that no data or meta data is required when an event notification is raised.

      • Metadata

        public static final EventDataFilter Metadata
        This specifies that only meta data of cache item is required when an event notification is raised.Meta data includes in information like groups, subgroups, cacheItemPriority, item version etc.

      • DataWithMetadata

        public static final EventDataFilter DataWithMetadata
        This specifies that the value of the cache item is required along with all the meta data when an event notification is raised.

    • Method Detail

      • values

        public static EventDataFilter[] 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 (EventDataFilter c : EventDataFilter.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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