com.google.gerrit.server.cache.PersistentCacheBinding Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation

API for Gerrit Plugins

The newest version!

// 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 extends CacheBinding {
  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding maximumWeight(long weight);

  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding expireAfterWrite(Duration duration);

  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding loader(Class> clazz);

  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding expireFromMemoryAfterAccess(Duration duration);

  @Override
  @CanIgnoreReturnValue
  PersistentCacheBinding weigher(Class> clazz);

  @CanIgnoreReturnValue
  PersistentCacheBinding version(int version);

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

  @CanIgnoreReturnValue
  PersistentCacheBinding keySerializer(CacheSerializer keySerializer);

  @CanIgnoreReturnValue
  PersistentCacheBinding valueSerializer(CacheSerializer valueSerializer);
}