com.google.common.cache.ForwardingCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*
 * 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.base.Preconditions;
import com.google.common.collect.ForwardingObject;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.ExecutionException;
import javax.annotation.Nullable;

/**
 *  A cache which forwards all its method calls to another cache. Subclasses should override one or
 *  more methods to modify the behavior of the backing cache as desired per the
 *  decorator pattern.
 *
 *  @author Charles Fry
 *  @since 10.0
 *
 * @deprecated The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
 */
@Beta
@Deprecated(since = "2022-12-01")
public abstract class ForwardingCache extends ForwardingObject implements Cache {

    /**
     * Constructor for use by subclasses.
     */
    protected ForwardingCache() {
    }

    @Override
    protected abstract Cache delegate();

    /**
     * @since 11.0
     */
    @Override
    @Nullable
    public V getIfPresent(Object key) {
        return delegate().getIfPresent(key);
    }

    /**
     * @since 11.0
     */
    @Override
    public V get(K key, Callable valueLoader) throws ExecutionException {
        return delegate().get(key, valueLoader);
    }

    /**
     * @since 11.0
     */
    @Override
    public ImmutableMap getAllPresent(Iterable keys) {
        return delegate().getAllPresent(keys);
    }

    /**
     * @since 11.0
     */
    @Override
    public void put(K key, V value) {
        delegate().put(key, value);
    }

    /**
     * @since 12.0
     */
    @Override
    public void putAll(Map m) {
        delegate().putAll(m);
    }

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

    /**
     * @since 11.0
     */
    @Override
    public void invalidateAll(Iterable keys) {
        delegate().invalidateAll(keys);
    }

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

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

    @Override
    public CacheStats stats() {
        return delegate().stats();
    }

    @Override
    public ConcurrentMap asMap() {
        return delegate().asMap();
    }

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

    /**
     *  A simplified version of {@link ForwardingCache} where subclasses can pass in an already
     *  constructed {@link Cache} as the delegete.
     *
     *  @since 10.0
     *
     * @deprecated The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
     */
    @Beta
    @Deprecated(since = "2022-12-01")
    public abstract static class SimpleForwardingCache extends ForwardingCache {

        private final Cache delegate;

        protected SimpleForwardingCache(Cache delegate) {
            this.delegate = Preconditions.checkNotNull(delegate);
        }

        @Override
        protected final Cache delegate() {
            return delegate;
        }
    }
}