Line data    Source code

       1             : // Copyright (C) 2019 The Android Open Source Project
       2             : //
       3             : // Licensed under the Apache License, Version 2.0 (the "License");
       4             : // you may not use this file except in compliance with the License.
       5             : // You may obtain a copy of the License at
       6             : //
       7             : // http://www.apache.org/licenses/LICENSE-2.0
       8             : //
       9             : // Unless required by applicable law or agreed to in writing, software
      10             : // distributed under the License is distributed on an "AS IS" BASIS,
      11             : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      12             : // See the License for the specific language governing permissions and
      13             : // limitations under the License.
      14             : 
      15             : package com.google.gerrit.server.index;
      16             : 
      17             : import com.google.auto.value.AutoValue;
      18             : import com.google.errorprone.annotations.FormatMethod;
      19             : import java.util.Optional;
      20             : 
      21             : /** Structured result of a staleness check. */
      22             : @AutoValue
      23          11 : public abstract class StalenessCheckResult {
      24             : 
      25             :   public static StalenessCheckResult notStale() {
      26           8 :     return new AutoValue_StalenessCheckResult(false, Optional.empty());
      27             :   }
      28             : 
      29             :   public static StalenessCheckResult stale(String reason) {
      30          11 :     return new AutoValue_StalenessCheckResult(true, Optional.of(reason));
      31             :   }
      32             : 
      33             :   @FormatMethod
      34             :   public static StalenessCheckResult stale(String reason, Object... args) {
      35          11 :     return stale(String.format(reason, args));
      36             :   }
      37             : 
      38             :   public abstract boolean isStale();
      39             : 
      40             :   public abstract Optional<String> reason();
      41             : }