com.github.benmanes.caffeine.guava.CaffeinatedGuavaCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guava Show documentation
A high performance caching library
There is a newer version: 3.1.8
/*
 * Copyright 2015 Ben Manes. All Rights Reserved.
 *
 * 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.github.benmanes.caffeine.guava;

import static java.util.Objects.requireNonNull;

import java.io.Serializable;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Callable;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.ExecutionException;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Predicate;

import org.checkerframework.checker.nullness.qual.Nullable;

import com.google.common.cache.Cache;
import com.google.common.cache.CacheLoader.InvalidCacheLoadException;
import com.google.common.cache.CacheStats;
import com.google.common.collect.ForwardingCollection;
import com.google.common.collect.ForwardingConcurrentMap;
import com.google.common.collect.ForwardingSet;
import com.google.common.collect.ImmutableMap;
import com.google.common.util.concurrent.ExecutionError;
import com.google.common.util.concurrent.UncheckedExecutionException;

/**
 * A Caffeine-backed cache through a Guava facade.
 *
 * @author [email protected] (Ben Manes)
 */
class CaffeinatedGuavaCache implements Cache, Serializable {
  static final long serialVersionUID = 1L;

  final com.github.benmanes.caffeine.cache.Cache cache;

  CaffeinatedGuavaCache(com.github.benmanes.caffeine.cache.Cache cache) {
    this.cache = requireNonNull(cache);
  }

  @Override @Nullable
  public V getIfPresent(Object key) {
    return cache.getIfPresent(key);
  }

  @Override
  @SuppressWarnings({"PMD.PreserveStackTrace", "PMD.ExceptionAsFlowControl", "NullAway"})
  public V get(K key, Callable valueLoader) throws ExecutionException {
    requireNonNull(valueLoader);
    try {
      return cache.get(key, k -> {
        try {
          V value = valueLoader.call();
          if (value == null) {
            throw new InvalidCacheLoadException("null value");
          }
          return value;
        } catch (InvalidCacheLoadException e) {
          throw e;
        } catch (RuntimeException e) {
          throw new UncheckedExecutionException(e);
        } catch (InterruptedException e) {
          Thread.currentThread().interrupt();
          throw new CacheLoaderException(e);
        } catch (Exception e) {
          throw new CacheLoaderException(e);
        } catch (Error e) {
          throw new ExecutionError(e);
        }
      });
    } catch (CacheLoaderException e) {
      throw new ExecutionException(e.getCause());
    }
  }

  @Override
  public ImmutableMap getAllPresent(Iterable keys) {
    return ImmutableMap.copyOf(cache.getAllPresent(keys));
  }

  @Override
  public void put(K key, V value) {
    cache.put(key, value);
  }

  @Override
  public void putAll(Map m) {
    cache.putAll(m);
  }

  @Override
  public void invalidate(Object key) {
    cache.invalidate(key);
  }

  @Override
  public void invalidateAll(Iterable keys) {
    cache.invalidateAll(keys);
  }

  @Override
  public void invalidateAll() {
    cache.invalidateAll();
  }

  @Override
  public long size() {
    return cache.estimatedSize();
  }

  @Override
  public CacheStats stats() {
    com.github.benmanes.caffeine.cache.stats.CacheStats stats = cache.stats();
    return new CacheStats(stats.hitCount(), stats.missCount(), stats.loadSuccessCount(),
        stats.loadFailureCount(), stats.totalLoadTime(), stats.evictionCount());
  }

  @Override
  public ConcurrentMap asMap() {
    return new ForwardingConcurrentMap() {
      @Override public boolean containsKey(Object key) {
        return (key != null) && delegate().containsKey(key);
      }
      @Override public boolean containsValue(Object value) {
        return (value != null) && delegate().containsValue(value);
      }
      @Override public void replaceAll(BiFunction function) {
        delegate().replaceAll(function);
      }
      @Override public V computeIfAbsent(K key, Function mappingFunction) {
        return delegate().computeIfAbsent(key, mappingFunction);
      }
      @Override public V computeIfPresent(K key,
          BiFunction remappingFunction) {
        return delegate().computeIfPresent(key, remappingFunction);
      }
      @Override public V compute(K key,
          BiFunction remappingFunction) {
        return delegate().compute(key, remappingFunction);
      }
      @Override public V merge(K key, V value,
          BiFunction remappingFunction) {
        return delegate().merge(key, value, remappingFunction);
      }
      @Override public Set keySet() {
        return new ForwardingSet() {
          @Override public boolean removeIf(Predicate filter) {
            return delegate().removeIf(filter);
          }
          @Override public boolean remove(Object o) {
            return (o != null) && delegate().remove(o);
          }
          @Override protected Set delegate() {
            return cache.asMap().keySet();
          }
        };
      }
      @Override public Collection values() {
        return new ForwardingCollection() {
          @Override public boolean removeIf(Predicate filter) {
            return delegate().removeIf(filter);
          }
          @Override public boolean remove(Object o) {
            return (o != null) && delegate().remove(o);
          }
          @Override protected Collection delegate() {
            return cache.asMap().values();
          }
        };
      }
      @Override public Set> entrySet() {
        return new ForwardingSet>() {
          @Override public boolean add(Entry entry) {
            throw new UnsupportedOperationException();
          }
          @Override public boolean addAll(Collection> entry) {
            throw new UnsupportedOperationException();
          }
          @Override public boolean removeIf(Predicate> filter) {
            return delegate().removeIf(filter);
          }
          @Override protected Set> delegate() {
            return cache.asMap().entrySet();
          }
        };
      }
      @Override protected ConcurrentMap delegate() {
        return cache.asMap();
      }
    };
  }

  @Override
  public void cleanUp() {
    cache.cleanUp();
  }

  static final class CacheLoaderException extends RuntimeException {
    private static final long serialVersionUID = 1L;

    CacheLoaderException(Exception e) {
      super(e);
    }
  }
}