org.ehcache.impl.events.CacheEventAdapter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ehcache-impl Show documentation
The implementation module of Ehcache 3
There is a newer version: 3.10.8
/*
 * 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 org.ehcache.impl.events;

import org.ehcache.event.CacheEvent;
import org.ehcache.event.CacheEventListener;

/**
 * Adapter for cache event listener implementation that splits the event based on its type
 * to specific methods. This class by default provides only empty methods.
 *
 * @param  the type of the keys from the cache
 * @param  the type of the values from the cache
 */
public abstract class CacheEventAdapter implements CacheEventListener {

  /**
   * {@inheritDoc}
   */
  @Override
  public final void onEvent(CacheEvent event) {
    switch (event.getType()) {
      case CREATED:
        onCreation(event.getKey(), event.getNewValue());
        break;
      case UPDATED:
        onUpdate(event.getKey(), event.getOldValue(), event.getNewValue());
        break;
      case REMOVED:
        onRemoval(event.getKey(), event.getOldValue());
        break;
      case EXPIRED:
        onExpiry(event.getKey(), event.getOldValue());
        break;
      case EVICTED:
        onEviction(event.getKey(), event.getOldValue());
        break;
      default:
        throw new AssertionError("Unsupported event type " + event.getType());
    }
  }

  /**
   * Invoked when a {@link CacheEvent} for an {@link org.ehcache.event.EventType#EVICTED eviction} is received.
   *
   * @param key the evicted key
   * @param evictedValue the evicted value
   */
  protected void onEviction(K key, V evictedValue) {
    // Do nothing by default
  }

  /**
   * Invoked when a {@link CacheEvent} for an {@link org.ehcache.event.EventType#EXPIRED expiration} is received.
   *
   * @param key the expired key
   * @param expiredValue the expired value
   */
  protected void onExpiry(K key, V expiredValue) {
    // Do nothing by default
  }

  /**
   * Invoked when a {@link CacheEvent} for a {@link org.ehcache.event.EventType#REMOVED removal} is received.
   *
   * @param key the removed key
   * @param removedValue the removed value
   */
  protected void onRemoval(K key, V removedValue) {
    // Do nothing by default
  }

  /**
   * Invoked when a {@link CacheEvent} for an {@link org.ehcache.event.EventType#UPDATED update} is received.
   *
   * @param key the updated key
   * @param oldValue the previous value
   * @param newValue the updated value
   */
  protected void onUpdate(K key, V oldValue, V newValue) {
    // Do nothing by default
  }

  /**
   * Invoked when a {@link CacheEvent} for a {@link org.ehcache.event.EventType#CREATED creation} is received.
   *
   * @param key the created key
   * @param newValue the created value
   */
  protected void onCreation(K key, V newValue) {
    // Do nothing by default
  }
}