/* * Copyright (C) 2011 The Guava Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.google.common.cache; import com.google.common.annotations.Beta; import com.google.common.annotations.GwtCompatible; import com.google.common.base.Function; import com.google.common.collect.ImmutableMap; import com.google.common.util.concurrent.ExecutionError; import com.google.common.util.concurrent.UncheckedExecutionException; import java.util.concurrent.Callable; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.ExecutionException; import javax.annotation.Nullable; /** * A semi-persistent mapping from keys to values. Cache entries are manually added using * {@link #get(K, Callable)} or {@link #put(K, V)}, and are stored in the cache until either * evicted or manually invalidated. * *
Note: in release 12.0, all methods moved from {@code Cache} to {@link LoadingCache} * will be deleted from {@code Cache}. As part of this transition {@code Cache} will no longer * extend {@link Function}. * *
Implementations of this interface are expected to be thread-safe, and can be safely accessed * by multiple concurrent threads. * *
All methods other than {@link #getIfPresent} are optional.
*
* @author Charles Fry
* @since 10.0
*/
@Beta
@GwtCompatible
public interface Cache Warning: as with {@link CacheLoader#load}, {@code valueLoader} must not return
* {@code null}; it may either return a non-null value or throw an exception.
*
* @throws ExecutionException if a checked exception was thrown while loading the value
* @throws UncheckedExecutionException if an unchecked exception was thrown while loading the
* value
* @throws ExecutionError if an error was thrown while loading the value
*
* @since 11.0
*/
V get(K key, Callable extends V> valueLoader) throws ExecutionException;
/**
* Returns a map of the values associated with {@code keys} in this cache. The returned map will
* only contain entries which are already present in the cache.
*
* @since 11.0
*/
ImmutableMap Prefer {@link #get(Object, Callable)} when using the conventional "if cached, return;
* otherwise create, cache and return" pattern.
*
* @since 11.0
*/
void put(K key, V value);
/**
* Discards any cached value for key {@code key}.
*/
void invalidate(Object key);
/**
* Discards any cached values for keys {@code keys}.
*
* @since 11.0
*/
void invalidateAll(Iterable> keys);
/**
* Discards all entries in the cache.
*/
void invalidateAll();
/**
* Returns the approximate number of entries in this cache.
*/
long size();
/**
* Returns a current snapshot of this cache's cumulative statistics. All stats are initialized
* to zero, and are monotonically increasing over the lifetime of the cache.
*/
CacheStats stats();
/**
* Returns a view of the entries stored in this cache as a thread-safe map. Modifications made to
* the map directly affect the cache.
*/
ConcurrentMap Warning: this method silently converts checked exceptions to unchecked exceptions,
* and should not be used with cache loaders which throw checked exceptions.
*
* @throws UncheckedExecutionException if an exception was thrown while loading the value,
* regardless of whether the exception was checked or unchecked
* @throws ExecutionError if an error was thrown while loading the value
* @deprecated This method has been split out into the {@link LoadingCache} interface, and will be
* removed from {@code Cache} in Guava release 12.0. Note that
* {@link CacheBuilder#build(CacheLoader)} now returns a {@code LoadingCache}, so this deprecation
* (migration) can be dealt with by simply changing the type of references to the results of
* {@link CacheBuilder#build(CacheLoader)}.
*/
@Deprecated V getUnchecked(K key);
/**
* Discouraged. Provided to satisfy the {@code Function} interface; use {@link #get} or
* {@link #getUnchecked} instead.
*
* @throws UncheckedExecutionException if an exception was thrown while loading the value,
* regardless of whether the exception was checked or unchecked
* @throws ExecutionError if an error was thrown while loading the value
* @deprecated This method has been split out into the {@link LoadingCache} interface, and will be
* removed from {@code Cache} in Guava release 12.0. Note that
* {@link CacheBuilder#build(CacheLoader)} now returns a {@code LoadingCache}, so this deprecation
* (migration) can be dealt with by simply changing the type of references to the results of
* {@link CacheBuilder#build(CacheLoader)}.
*/
@Deprecated V apply(K key);
}