java/com/google/gerrit/server/config/DefaultPreferencesCache.java

// Copyright (C) 2020 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.config;

import org.eclipse.jgit.lib.ObjectId;

/** Cache for Gerrit's default preferences (general, diff edit). */
public interface DefaultPreferencesCache {
  /**
   * Static member to be returned when there is no default config. This prevents re-instantiating
   * many {@link CachedPreferences} in this case.
   */
  CachedPreferences EMPTY = CachedPreferences.fromString("");

  /** Returns a cached instance of {@link CachedPreferences}. */
  CachedPreferences get();

  /** Returns a cached instance of {@link CachedPreferences} at the specified revision. */
  CachedPreferences get(ObjectId rev);
}