java/com/google/gerrit/server/cache/PersistentCacheBinding.java

// Copyright (C) 2018 The Android Open Source Project
//
// 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.gerrit.server.cache;

import com.google.common.cache.CacheLoader;
import com.google.common.cache.Weigher;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.gerrit.server.cache.serialize.CacheSerializer;
import java.time.Duration;

/** Configure a persistent cache declared within a {@link CacheModule} instance. */
public interface PersistentCacheBinding<K, V> extends CacheBinding<K, V> {
  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> maximumWeight(long weight);

  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> expireAfterWrite(Duration duration);

  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> loader(Class<? extends CacheLoader<K, V>> clazz);

  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> expireFromMemoryAfterAccess(Duration duration);

  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> weigher(Class<? extends Weigher<K, V>> clazz);

  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> version(int version);

  /**
   * Set the total on-disk limit of the cache.
   *
   * <p>If 0 or negative, persistence for the cache is disabled by default, but may still be
   * overridden in the config.
   */
  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> diskLimit(long limit);

  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> keySerializer(CacheSerializer<K> keySerializer);

  @CanIgnoreReturnValue
  PersistentCacheBinding<K, V> valueSerializer(CacheSerializer<V> valueSerializer);
}