com.gluonhq.charm.down.common.cache.Cache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of charm-down-common Show documentation
API to access features for the mobile platforms
The newest version!
/*
 * Copyright (c) 2015, Gluon
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *     * Neither the name of Gluon, any associated website, nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL GLUON BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.gluonhq.charm.down.common.cache;


/**
 *
 * @param  type for the key
 * @param  type for the value
 */
public interface Cache  {
   
    /**
     * Get the value for the specified key, or null when there is no such key.
     * The latter can be because there never was an entry with this key stored, or the
     * entry with this key has been reclaimed.
     * 
     * @param key the key for which we need the value
     * @return the value for the specified key, null in case there is no
     * value corresponding to this key.
     */
    V get (K key);
    
    /**
     * Stores a key-value pair in the cache. A NullPointerException will be
     * thrown if the key or the value are null.
     * @param key the key, should not be null
     * @param value the value, should not be null
     */
    void put (K key, V value);
    
    /**
     * Remove the entry associated with this key.
     * @param key the key for which the entry is requested
     * @return true if the cache contained an entry with this key
     */
    boolean remove (K key);
    
    /**
     * Remove all entries from the cache
     */
    void removeAll ();

}