javax.cache.event.CacheEntryEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cache-api Show documentation

There is a newer version: 1.1.1

/**
 *  Copyright (c) 2011 Terracotta, Inc.
 *  Copyright (c) 2011 Oracle and/or its affiliates.
 *
 *  All rights reserved. Use is subject to license terms.
 */

package javax.cache.event;

import javax.cache.Cache;
import java.util.EventObject;

/**
 * A Cache event base class
 * @param  the type of keys maintained by this cache
 * @param  the type of cached values
 * @since 1.0
 */
public abstract class CacheEntryEvent extends EventObject {

    /**
     * Constructs a cache entry event from a given cache as source
     * @param source the cache that originated the event
     */
    public CacheEntryEvent(Cache source) {
        super(source);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final Cache getSource() {
        return (Cache) super.getSource();
    }

    /**
     * Returns the key of the cache entry with the event
     * @return the key
     */
    public abstract K getKey();

    /**
     * Returns the value of the cache entry with the event
     * @return the value
     */
    public abstract V getValue();

    /**
     * Returns the value of the cache entry with the event
     * @return the value
     * @throws UnsupportedOperationException if the old value is not available
     */
    public abstract V getOldValue() throws UnsupportedOperationException;


    /**
     * Whether the old value is available
     * @return true if the old value is populated
     */
    public abstract boolean isOldValueAvailable();

}