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

com.cedarsoftware.util.GuavaCache.groovy Maven / Gradle / Ivy

There is a newer version: 5.6.9
Show newest version
/*
 * Copyright 2002-2015 the original author or 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.cedarsoftware.util

import groovy.transform.CompileStatic
import org.springframework.cache.Cache
import org.springframework.cache.support.NullValue

import java.util.concurrent.Callable
import java.util.concurrent.ExecutionException

import com.google.common.cache.LoadingCache
import com.google.common.util.concurrent.UncheckedExecutionException

import org.springframework.cache.support.AbstractValueAdaptingCache
import org.springframework.util.Assert

/**
 * Spring {@link org.springframework.cache.Cache} adapter implementation
 * on top of a Guava {@link com.google.common.cache.Cache} instance.
 *
 * 

Requires Google Guava 12.0 or higher. * * @author Juergen Hoeller * @author Stephane Nicoll * @since 4.0 */ @CompileStatic class GuavaCache extends AbstractValueAdaptingCache implements Cache { private final String name private final com.google.common.cache.Cache cache /** * Create a {@link GuavaCache} instance with the specified name and the * given internal {@link com.google.common.cache.Cache} to use. * @param name the name of the cache * @param cache the backing Guava Cache instance */ GuavaCache(String name, com.google.common.cache.Cache cache) { this(name, cache, true) } /** * Create a {@link GuavaCache} instance with the specified name and the * given internal {@link com.google.common.cache.Cache} to use. * @param name the name of the cache * @param cache the backing Guava Cache instance * @param allowNullValues whether to accept and convert {@code null} * values for this cache */ GuavaCache(String name, com.google.common.cache.Cache cache, boolean allowNullValues) { super(allowNullValues) Assert.notNull(name, "Name must not be null") Assert.notNull(cache, "Cache must not be null") this.name = name this.cache = cache } final String getName() { return name } final com.google.common.cache.Cache getNativeCache() { return cache } Map asMap() { return cache.asMap() } ValueWrapper get(Object key) { if (this.cache instanceof LoadingCache) { try { Object value = ((LoadingCache) this.cache).get(key) return toValueWrapper(value) } catch (ExecutionException ex) { throw new UncheckedExecutionException(ex.message, ex) } } return super.get(key) } @SuppressWarnings("unchecked") T get(Object key, final Callable valueLoader) { try { return (T) fromStoreValue(this.cache.get(key, new Callable() { Object call() throws Exception { return storeValue(valueLoader.call()) } })) } catch (ExecutionException ex) { throw new ValueRetrievalException(key, valueLoader, ex.cause) } catch (UncheckedExecutionException ex) { throw new ValueRetrievalException(key, valueLoader, ex.cause) } } protected Object lookup(Object key) { return cache.getIfPresent(key) } void put(Object key, Object value) { cache.put(key, storeValue(value)) } ValueWrapper putIfAbsent(Object key, final Object value) { try { PutIfAbsentCallable callable = new PutIfAbsentCallable(value) Object result = this.cache.get(key, callable) return (callable.called ? null : toValueWrapper(result)) } catch (ExecutionException ex) { throw new IllegalStateException(ex) } } void evict(Object key) { cache.invalidate(key) } void clear() { cache.invalidateAll() } private class PutIfAbsentCallable implements Callable { private final Object value private boolean called PutIfAbsentCallable(Object value) { this.value = value } Object call() throws Exception { this.called = true return storeValue(this.value) } } /** * Convert the given user value, as passed into the put method, * to a value in the internal store (adapting {@code null}). * @param userValue the given user value * @return the value to store */ protected Object storeValue(Object userValue) { if (this.allowNullValues && userValue == null) { return NullValue.INSTANCE } return userValue } }