com.google.gerrit.server.cache.CacheDef Maven / Gradle / Ivy
// 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.gerrit.common.Nullable;
import com.google.inject.TypeLiteral;
import java.time.Duration;
public interface CacheDef {
/**
* Unique name for this cache.
*
* The name can be used in a binding annotation {@code @Named(name)} to inject the cache
* configured with this binding.
*/
String name();
/**
* Key to use when looking up configuration for this cache.
*
*
Typically, this will match the result of {@link #name()}, so that configuration is keyed by
* the actual cache name. However, it may be changed, for example to reuse the size limits of some
* other cache.
*/
String configKey();
TypeLiteral keyType();
TypeLiteral valueType();
long maximumWeight();
@Nullable
Duration expireAfterWrite();
@Nullable
Duration expireFromMemoryAfterAccess();
@Nullable
Duration refreshAfterWrite();
@Nullable
Weigher weigher();
@Nullable
CacheLoader loader();
}