net.sf.ehcache.event.NotificationScope Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ehcache-core Show documentation

Internal ehcache-core module. This artifact is not meant to be used directly for jdk 1.5

The newest version!

/**
 *  Copyright Terracotta, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package net.sf.ehcache.event;

/**
 * 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.
 *
 * @author Geert Bevin
 * @since 2.0
 */
public enum NotificationScope {
    /**
     * Receive only events generated by this CacheManager
     */
    LOCAL(true, false),

    /**
     * Receive only events generated by another CacheManager
     */
    REMOTE(false, true),

    /**
     * Receive all events
     */
    ALL(true, true);


    private final boolean deliverLocal;
    private final boolean deliverRemote;

    private NotificationScope(boolean deliverLocal, boolean deliverRemote) {
        this.deliverLocal = deliverLocal;
        this.deliverRemote = deliverRemote;
    }

    /**
     * Determine whether an event should be delivered under this notification scope.
     *
     * @param isRemote Whether the event is local or remote
     * @return True if the event should be delivered to a listener with this notification scope
     */
    public boolean shouldDeliver(boolean isRemote) {
        return (isRemote && deliverRemote) || (!isRemote && deliverLocal);
    }

}