Line data    Source code

       1             : // Copyright (C) 2014 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.extensions.webui;
      16             : 
      17             : import com.google.gerrit.extensions.annotations.ExtensionPoint;
      18             : import com.google.gerrit.extensions.common.WebLinkInfo;
      19             : 
      20             : @ExtensionPoint
      21             : public interface PatchSetWebLink extends WebLink {
      22             : 
      23             :   /**
      24             :    * {@link com.google.gerrit.extensions.common.WebLinkInfo} describing a link from a patch set to
      25             :    * an external service.
      26             :    *
      27             :    * <p>In order for the web link to be visible {@link
      28             :    * com.google.gerrit.extensions.common.WebLinkInfo#url} and {@link
      29             :    * com.google.gerrit.extensions.common.WebLinkInfo#name} must be set.
      30             :    *
      31             :    * <p>
      32             :    *
      33             :    * @param projectName name of the project
      34             :    * @param commit commit of the patch set
      35             :    * @param commitMessage the commit message of the change
      36             :    * @param branchName target branch of the change
      37             :    * @return WebLinkInfo that links to patch set in external service, null if there should be no
      38             :    *     link.
      39             :    */
      40             :   @Deprecated
      41             :   WebLinkInfo getPatchSetWebLink(
      42             :       String projectName, String commit, String commitMessage, String branchName);
      43             : 
      44             :   /**
      45             :    * {@link com.google.gerrit.extensions.common.WebLinkInfo} describing a link from a patch set to
      46             :    * an external service.
      47             :    *
      48             :    * <p>In order for the web link to be visible {@link
      49             :    * com.google.gerrit.extensions.common.WebLinkInfo#url} and {@link
      50             :    * com.google.gerrit.extensions.common.WebLinkInfo#name} must be set.
      51             :    *
      52             :    * <p>
      53             :    *
      54             :    * @param projectName name of the project
      55             :    * @param commit commit of the patch set
      56             :    * @param commitMessage the commit message of the change
      57             :    * @param branchName target branch of the change
      58             :    * @param changeKey the changeID for this change
      59             :    * @return WebLinkInfo that links to patch set in external service, null if there should be no
      60             :    *     link.
      61             :    */
      62             :   default WebLinkInfo getPatchSetWebLink(
      63             :       String projectName,
      64             :       String commit,
      65             :       String commitMessage,
      66             :       String branchName,
      67             :       String changeKey) {
      68           1 :     return getPatchSetWebLink(projectName, commit, commitMessage, branchName);
      69             :   }
      70             : }