javax.cache.event
Enum NotificationScope

java.lang.Object
  java.lang.Enum<NotificationScope>
      javax.cache.event.NotificationScope

All Implemented Interfaces:

Serializable, Comparable<NotificationScope>

public enum NotificationScope
extends Enum<NotificationScope>

This enumeration defines valid values for CacheEntryListener notification scope. A distributed cache may contain multiple CacheManager nodes. Events on a cache instance inside in the same JVM are considered local, other events are not.

A cache will only receive remote events if it registers a CacheEntryListener with a remote notification scope. Only those cluster members interested in receiving remote events should register such a listener.

There can be a large cost difference between receipt of local versus remote events thus allowing the choice. Accordingly, the remote notification scope is optional. This capability can be determined using Caching.isSupported(javax.cache.OptionalFeature).

Since:

1.0

Enum Constant Summary

LOCAL
Receive only events generated locally.

REMOTE
Receive only events generated by another JVM

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 locally.

REMOTE

public static final NotificationScope REMOTE

Receive only events generated by another JVM

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