javax.cache.expiry.ExpiryPolicy Maven / Gradle / Ivy
/**
* Copyright (c) 2011-2013 Terracotta, Inc.
* Copyright (c) 2011-2013 Oracle and/or its affiliates.
*
* All rights reserved. Use is subject to license terms.
*/
package javax.cache.expiry;
import javax.cache.Cache.Entry;
/**
* Defines functions to determine when cache entries will expire based on
* creation, access and modification operations.
*
* Each of the functions return a new {@link Duration} that of which specifies the
* amount of time that must pass before a cache entry is considered expired.
*
* @param the type of keys
* @param the type of values
* @author Brian Oliver
* @author Greg Luck
*/
public interface ExpiryPolicy {
/**
* Gets the duration before the newly Cache.Entry is considered expired.
*
* This method is called by the caching implementation after a Cache.Entry is
* created, but before the said entry is added to a cache, to determine the
* {@link Duration} before the said entry expires. If a {@link Duration#ZERO}
* is returned the Cache.Entry is considered to be already expired and will
* not be added to the Cache.
*
* Should an exception occur while determining the Duration, an implementation
* specific default Duration will be used.
*
* @param entry the cache entry that was created
* @return the new duration until the entry expires
*/
Duration getExpiryForCreatedEntry(Entry entry);
/**
* Gets the duration before the accessed Cache.Entry is considered expired.
*
* This method is called by the caching implementation after a Cache.Entry is
* accessed to determine the {@link Duration} before the said entry expires in
* the future. If a {@link Duration#ZERO} is returned the Cache.Entry will be
* considered expired for future access. Returning null will
* result in no change to the previously understood expiry {@link Duration}.
*
* Should an exception occur while determining the Duration, an implementation
* specific default Duration will be used.
*
* @param entry the cache entry that was accessed
* @return the new duration until the entry expires
*/
Duration getExpiryForAccessedEntry(Entry entry);
/**
* Gets the duration before the modified Cache.Entry is considered expired.
*
* This method is called by the caching implementation after a Cache.Entry is
* modified to determine the {@link Duration} before the updated entry expires.
* If a {@link Duration#ZERO} is returned the Cache.Entry is considered already
* expired. Returning null will result in no change to the
* previously understood expiry {@link Duration}.
*
* Should an exception occur while determining the Duration, an implementation
* specific default Duration will be used.
*
* @param entry the cache entry that was modified
* @return the new duration until the entry expires
*/
Duration getExpiryForModifiedEntry(Entry entry);
}