com.google.gerrit.server.project.SubmitRequirementsEvaluator 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

There is a newer version: 3.11.0-rc3

// Copyright (C) 2021 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.project;

import com.google.common.collect.ImmutableMap;
import com.google.gerrit.entities.SubmitRequirement;
import com.google.gerrit.entities.SubmitRequirementExpression;
import com.google.gerrit.entities.SubmitRequirementExpressionResult;
import com.google.gerrit.entities.SubmitRequirementResult;
import com.google.gerrit.index.query.QueryParseException;
import com.google.gerrit.server.query.change.ChangeData;

public interface SubmitRequirementsEvaluator {
  /**
   * Evaluate and return all submit requirement results for a change. Submit requirements are read
   * from the project config of the project containing the change as well as parent projects.
   *
   * @param cd change data corresponding to a specific gerrit change
   */
  ImmutableMap evaluateAllRequirements(ChangeData cd);

  /** Evaluate a single {@link SubmitRequirement} using change data. */
  SubmitRequirementResult evaluateRequirement(SubmitRequirement sr, ChangeData cd);

  /** Evaluate a {@link SubmitRequirementExpression} using change data. */
  SubmitRequirementExpressionResult evaluateExpression(
      SubmitRequirementExpression expression, ChangeData changeData);

  /**
   * Validate a {@link SubmitRequirementExpression}. Callers who wish to validate submit
   * requirements upon creation or update should use this method.
   *
   * @param expression entity containing the expression string.
   * @throws QueryParseException the expression string contains invalid syntax and can't be parsed.
   */
  void validateExpression(SubmitRequirementExpression expression) throws QueryParseException;
}