net.sf.ehcache.event
Enum NotificationScope

java.lang.Object
  java.lang.Enum<NotificationScope>
      net.sf.ehcache.event.NotificationScope

All Implemented Interfaces:

Serializable, Comparable<NotificationScope>

public enum NotificationScope
extends 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

ALL
Receive all events

LOCAL
Receive only events generated by this CacheManager

REMOTE
Receive only events generated by another CacheManager

Method Summary

boolean	shouldDeliver(boolean isRemote) Determine whether an event should be delivered under this notification scope.
static NotificationScope	valueOf(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

ALL

public static final NotificationScope ALL

Receive all events

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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

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