All Downloads are FREE. Search and download functionalities are using the official Maven repository.

src.gov.nasa.worldwind.cache.SessionCache Maven / Gradle / Ivy

Go to download 

/*
 * Copyright (C) 2012 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */
package gov.nasa.worldwind.cache;

/**
 * SessionCache is a general receiving area for data represented as key-value pairs. Entries in a SessionCache may
 * persist for the length of a Virtual Machine's run time, but may be evicted at any time.
 * 

 * Eviction of SessionCache entries is accomplished by controlling the maximum number of entries in the cache. This
 * maximum value is set by calling {@link #setCapacity(int)}. A SessionCache may be implemented with any eviction policy
 * (including a policy of no eviction). Most implementations evict the eldest entry added to the cache.
 *
 * @author dcollins
 * @version $Id: SessionCache.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public interface SessionCache
{
    /**
     * Returns the maximum number of entries in the cache.
     *
     * @return maximum number of entries in the cache.
     */
    int getCapacity();

    /**
     * Sets the maximum number of entries in the cache.
     *
     * @param capacity maximum number of enties in the cache.
     */
    void setCapacity(int capacity);

    /**
     * Returns the number of entries currently in the cache.
     *
     * @return number of cached entries.
     */
    int getEntryCount();

    /**
     * Returns a {@link java.util.Set} view of the keys contained in the cache.
     *
     * @return a {@link java.util.Set} view of the keys contained in the cache.
     */
    java.util.Set getKeySet();

    /**
     * Returns true if the cache contains a specified key, and false if it does not.
     *
     * @param key the entry key in question.
     *
     * @return true if the cache contains the key; false otherwise.
     */
    boolean contains(Object key);

    /**
     * Returns a reference to an entry's value in the cache corresponding to a specified key, or null if no entry with
     * that key exists.
     *
     * @param key the entry key to look for.
     *
     * @return a reference to the found entry's value.
     */
    Object get(Object key);

    /**
     * Adds an entry in the cache with a specified key and value.
     *
     * @param key   the entry's key.
     * @param value the entry's value.
     */
    void put(Object key, Object value);

    /**
     * Removes the entry with the specified key from the cache, and returns that entry's value. If no entry exists for
     * the specified key, this does nothing and returns null.
     *
     * @param key the entry key to look for.
     *
     * @return a reference to the removed entry's value, or null of no entry matches the specified key.
     */
    Object remove(Object key);

    /**
     * Removes all entries from the cache.
     */
    void clear();
}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy