com.google.gerrit.extensions.api.changes.RevisionApi 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) 2013 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.extensions.api.changes;

import com.google.common.collect.ListMultimap;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.extensions.client.ArchiveFormat;
import com.google.gerrit.extensions.client.SubmitType;
import com.google.gerrit.extensions.common.ActionInfo;
import com.google.gerrit.extensions.common.ApplyProvidedFixInput;
import com.google.gerrit.extensions.common.ApprovalInfo;
import com.google.gerrit.extensions.common.ChangeInfo;
import com.google.gerrit.extensions.common.CommentInfo;
import com.google.gerrit.extensions.common.CommitInfo;
import com.google.gerrit.extensions.common.DiffInfo;
import com.google.gerrit.extensions.common.EditInfo;
import com.google.gerrit.extensions.common.FileInfo;
import com.google.gerrit.extensions.common.MergeableInfo;
import com.google.gerrit.extensions.common.RobotCommentInfo;
import com.google.gerrit.extensions.common.TestSubmitRuleInfo;
import com.google.gerrit.extensions.common.TestSubmitRuleInput;
import com.google.gerrit.extensions.restapi.BinaryResult;
import com.google.gerrit.extensions.restapi.NotImplementedException;
import com.google.gerrit.extensions.restapi.RestApiException;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

public interface RevisionApi {
  String description() throws RestApiException;

  void description(String description) throws RestApiException;

  @CanIgnoreReturnValue
  ReviewResult review(ReviewInput in) throws RestApiException;

  @CanIgnoreReturnValue
  default ChangeInfo submit() throws RestApiException {
    SubmitInput in = new SubmitInput();
    return submit(in);
  }

  @CanIgnoreReturnValue
  ChangeInfo submit(SubmitInput in) throws RestApiException;

  @CanIgnoreReturnValue
  ChangeApi cherryPick(CherryPickInput in) throws RestApiException;

  ChangeInfo cherryPickAsInfo(CherryPickInput in) throws RestApiException;

  @CanIgnoreReturnValue
  default ChangeApi rebase() throws RestApiException {
    RebaseInput in = new RebaseInput();
    return rebase(in);
  }

  @CanIgnoreReturnValue
  ChangeApi rebase(RebaseInput in) throws RestApiException;

  ChangeInfo rebaseAsInfo(RebaseInput in) throws RestApiException;

  boolean canRebase() throws RestApiException;

  RevisionReviewerApi reviewer(String id) throws RestApiException;

  void setReviewed(String path, boolean reviewed) throws RestApiException;

  Set reviewed() throws RestApiException;

  default Map files() throws RestApiException {
    return files(null);
  }

  Map files(@Nullable String base) throws RestApiException;

  Map files(int parentNum) throws RestApiException;

  List queryFiles(String query) throws RestApiException;

  FileApi file(String path);

  CommitInfo commit(boolean addLinks) throws RestApiException;

  MergeableInfo mergeable() throws RestApiException;

  MergeableInfo mergeableOtherBranches() throws RestApiException;

  Map> comments() throws RestApiException;

  Map> robotComments() throws RestApiException;

  Map> drafts() throws RestApiException;

  List commentsAsList() throws RestApiException;

  List draftsAsList() throws RestApiException;

  List robotCommentsAsList() throws RestApiException;

  Map> portedComments() throws RestApiException;

  Map> portedDrafts() throws RestApiException;

  /**
   * Applies the indicated fix by creating a new change edit or integrating the fix with the
   * existing change edit. If no change edit exists before this call, the fix must refer to the
   * current patch set. If a change edit exists, the fix must refer to the patch set on which the
   * change edit is based.
   *
   * @param fixId the ID of the fix which should be applied
   * @throws RestApiException if the fix couldn't be applied
   */
  @CanIgnoreReturnValue
  EditInfo applyFix(String fixId) throws RestApiException;

  /**
   * Applies fix similar to {@code applyFix} method. Instead of using a fix stored in the server,
   * this applies the fix provided in {@code ApplyProvidedFixInput}
   *
   * @param applyProvidedFixInput The fix(es) to apply to a new change edit.
   * @throws RestApiException if the fix couldn't be applied.
   */
  @CanIgnoreReturnValue
  EditInfo applyFix(ApplyProvidedFixInput applyProvidedFixInput) throws RestApiException;

  Map getFixPreview(String fixId) throws RestApiException;

  Map getFixPreview(ApplyProvidedFixInput applyProvidedFixInput)
      throws RestApiException;

  @CanIgnoreReturnValue
  DraftApi createDraft(DraftInput in) throws RestApiException;

  DraftApi draft(String id) throws RestApiException;

  CommentApi comment(String id) throws RestApiException;

  RobotCommentApi robotComment(String id) throws RestApiException;

  String etag() throws RestApiException;

  /** Returns patch of revision. */
  BinaryResult patch() throws RestApiException;

  BinaryResult patch(String path) throws RestApiException;

  Map actions() throws RestApiException;

  SubmitType submitType() throws RestApiException;

  SubmitType testSubmitType(TestSubmitRuleInput in) throws RestApiException;

  TestSubmitRuleInfo testSubmitRule(TestSubmitRuleInput in) throws RestApiException;

  MergeListRequest getMergeList() throws RestApiException;

  RelatedChangesInfo related() throws RestApiException;

  RelatedChangesInfo related(EnumSet listOptions) throws RestApiException;

  /** Returns votes on the revision. */
  ListMultimap votes() throws RestApiException;

  /**
   * Retrieves the revision as an archive.
   *
   * @param format the format of the archive
   * @return the archive as {@link BinaryResult}
   */
  BinaryResult getArchive(ArchiveFormat format) throws RestApiException;

  abstract class MergeListRequest {
    private boolean addLinks;
    private int uninterestingParent = 1;

    public abstract List get() throws RestApiException;

    public MergeListRequest withLinks() {
      this.addLinks = true;
      return this;
    }

    public MergeListRequest withUninterestingParent(int uninterestingParent) {
      this.uninterestingParent = uninterestingParent;
      return this;
    }

    public boolean getAddLinks() {
      return addLinks;
    }

    public int getUninterestingParent() {
      return uninterestingParent;
    }
  }

  /**
   * A default implementation which allows source compatibility when adding new methods to the
   * interface.
   */
  class NotImplemented implements RevisionApi {
    @Override
    public ReviewResult review(ReviewInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public ChangeInfo submit(SubmitInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public ChangeApi cherryPick(CherryPickInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public ChangeInfo cherryPickAsInfo(CherryPickInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public ChangeApi rebase(RebaseInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public ChangeInfo rebaseAsInfo(RebaseInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public boolean canRebase() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public RevisionReviewerApi reviewer(String id) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public void setReviewed(String path, boolean reviewed) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Set reviewed() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public MergeableInfo mergeable() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public MergeableInfo mergeableOtherBranches() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map files(String base) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map files(int parentNum) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public List queryFiles(String query) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public FileApi file(String path) {
      throw new NotImplementedException();
    }

    @Override
    public CommitInfo commit(boolean addLinks) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map> comments() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map> robotComments() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public List commentsAsList() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public List draftsAsList() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public List robotCommentsAsList() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map> portedComments() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map> portedDrafts() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public EditInfo applyFix(String fixId) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public EditInfo applyFix(ApplyProvidedFixInput applyProvidedFixInput) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map getFixPreview(String fixId) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map getFixPreview(ApplyProvidedFixInput applyProvidedFixInput)
        throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map> drafts() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public DraftApi createDraft(DraftInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public DraftApi draft(String id) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public CommentApi comment(String id) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public RobotCommentApi robotComment(String id) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public BinaryResult patch() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public BinaryResult patch(String path) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public Map actions() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public SubmitType submitType() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public SubmitType testSubmitType(TestSubmitRuleInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public TestSubmitRuleInfo testSubmitRule(TestSubmitRuleInput in) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public MergeListRequest getMergeList() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public RelatedChangesInfo related() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public RelatedChangesInfo related(EnumSet options) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public ListMultimap votes() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public void description(String description) throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public String description() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public String etag() throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public BinaryResult getArchive(ArchiveFormat format) throws RestApiException {
      throw new NotImplementedException();
    }
  }
}