io.trino.collect.cache.SafeCaches Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trino-collect Show documentation
There is a newer version: 420
/*
 * 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 io.trino.collect.cache;

import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import org.gaul.modernizer_maven_annotations.SuppressModernizer;

/**
 * @see EvictableCache
 * @see EvictableCacheBuilder
 */
public final class SafeCaches
{
    private SafeCaches() {}

    public static  NonEvictableCache buildNonEvictableCache(CacheBuilder cacheBuilder)
    {
        return new NonEvictableCacheImpl<>(buildUnsafeCache(cacheBuilder));
    }

    /**
     * Builds a cache that supports {@link Cache#invalidateAll()} with best-effort semantics:
     * there is no guarantee that cache is empty after {@code invalidateAll()} returns, or that
     * subsequent read will not see stale state.
     */
    public static  NonKeyEvictableCache buildNonEvictableCacheWithWeakInvalidateAll(CacheBuilder cacheBuilder)
    {
        return new NonKeyEvictableCacheImpl<>(buildUnsafeCache(cacheBuilder));
    }

    public static  NonEvictableLoadingCache buildNonEvictableCache(CacheBuilder cacheBuilder, CacheLoader cacheLoader)
    {
        return new NonEvictableLoadingCacheImpl<>(buildUnsafeCache(cacheBuilder, cacheLoader));
    }

    /**
     * Builds a cache that supports {@link Cache#invalidateAll()} with best-effort semantics:
     * there is no guarantee that cache is empty after {@code invalidateAll()} returns, or that
     * subsequent read will not see stale state.
     */
    public static  NonKeyEvictableLoadingCache buildNonEvictableCacheWithWeakInvalidateAll(
            CacheBuilder cacheBuilder,
            CacheLoader cacheLoader)
    {
        return new NonKeyEvictableLoadingCacheImpl<>(buildUnsafeCache(cacheBuilder, cacheLoader));
    }

    @SuppressModernizer // CacheBuilder.build() is forbidden, advising to use this class as a safety-adding wrapper.
    private static  Cache buildUnsafeCache(CacheBuilder cacheBuilder)
    {
        return cacheBuilder.build();
    }

    @SuppressModernizer // CacheBuilder.build(CacheLoader) is forbidden, advising to use this class as a safety-adding wrapper.
    private static  LoadingCache buildUnsafeCache(CacheBuilder cacheBuilder, CacheLoader cacheLoader)
    {
        return cacheBuilder.build(cacheLoader);
    }
}