Package net.sf.ehcache.event

Enum NotificationScope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<NotificationScope>
    public enum NotificationScope
extends java.lang.Enum<NotificationScope>
    This enumeration defines valid values for event listener notification scope. By default an event listener will be open to listening for events created on all nodes (ALL). You may also specify to receive only LOCAL events or only REMOTE events.
    Since:
    2.0
    Author:
    Geert Bevin

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL
      Receive all events
      LOCAL
      Receive only events generated by this CacheManager
      REMOTE
      Receive only events generated by another CacheManager

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean shouldDeliver​(boolean isRemote)
      Determine whether an event should be delivered under this notification scope.
      static NotificationScope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static NotificationScope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • LOCAL

        public static final NotificationScope LOCAL
        Receive only events generated by this CacheManager

      • REMOTE

        public static final NotificationScope REMOTE
        Receive only events generated by another CacheManager

    • Method Detail

      • values

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

      • valueOf

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

      • shouldDeliver

        public boolean shouldDeliver​(boolean isRemote)
        Determine whether an event should be delivered under this notification scope.
        Parameters:
        isRemote - Whether the event is local or remote
        Returns:
        True if the event should be delivered to a listener with this notification scope