All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.quarkus.cache.CaffeineCache Maven / Gradle / Ivy

    There is a newer version: 3.17.5
    Show newest version
    package io.quarkus.cache;

import java.time.Duration;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;

public interface CaffeineCache extends Cache {

    /**
     * Returns an unmodifiable {@link Set} view of the keys contained in this cache. If the cache entries are modified while an
     * iteration over the set is in progress, the set will remain unchanged.
     *
     * @return a set view of the keys contained in this cache
     */
    Set keySet();

    /**
     * Returns the future associated with {@code key} in this cache, or {@code null} if there is no
     * cached future for {@code key}. This method is delegating to the
     * {@link com.github.benmanes.caffeine.cache.AsyncCache#getIfPresent(Object)}, while recording the cache stats if they are
     * enabled.
     *
     * @param key key whose associated value is to be returned
     * @return the future value to which the specified key is mapped, or {@code null} if this cache
     *         does not contain a mapping for the key
     * @throws NullPointerException if the specified key is null
     * @see com.github.benmanes.caffeine.cache.AsyncCache#getIfPresent(Object)
     */
     CompletableFuture getIfPresent(Object key);

    /**
     * Associates {@code value} with {@code key} in this cache. If the cache previously contained a
     * value associated with {@code key}, the old value is replaced by {@code value}. If the
     * asynchronous computation fails, the entry will be automatically removed.
     * 
    
     * Prefer {@link #get(Object, Function)} when using the conventional "if cached, return; otherwise
     * create, cache and return" pattern.
     *
     * @param key key with which the specified value is to be associated
     * @param valueFuture value to be associated with the specified key
     * @throws NullPointerException if the specified key or value is null
     */
     void put(Object key, CompletableFuture valueFuture);

    /**
     * Changes the duration, initially set from the configuration, after which each entry should be automatically removed from
     * the cache once that duration has elapsed after the entry's creation, or the most recent replacement of its value.
     * 
    
     * Warning: this method must not be invoked from within an atomic scope of a cache operation.
     *
     * @param duration the length of time after which an entry should be automatically removed
     * @throws IllegalStateException if the cache was not constructed with an {@code expire-after-write} configuration value
     */
    void setExpireAfterWrite(Duration duration);

    /**
     * Changes the duration, initially set from the configuration, after which each entry should be automatically removed from
     * the cache once that duration has elapsed after the entry's creation, the most recent replacement of its value, or its
     * last read.
     * 
    
     * Warning: this method must not be invoked from within an atomic scope of a cache operation.
     *
     * @param duration the length of time after which an entry should be automatically removed
     * @throws IllegalStateException if the cache was not constructed with an {@code expire-after-access} configuration value
     */
    void setExpireAfterAccess(Duration duration);

    /**
     * Changes the maximum number of entries the cache may contain.
     * 
    
     * Warning: this method must not be invoked from within an atomic scope of a cache operation.
     *
     * @param maximumSize the maximum size of the cache
     * @throws IllegalStateException if the cache was not constructed with a {@code maximum-size} configuration value
     */
    void setMaximumSize(long maximumSize);
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy