gerrit-extension-api/src/main/java/com/google/gerrit/extensions/webui/PatchSetWebLink.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

// Copyright (C) 2014 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.webui;

import com.google.gerrit.extensions.annotations.ExtensionPoint;
import com.google.gerrit.extensions.common.WebLinkInfo;

@ExtensionPoint
public interface PatchSetWebLink extends WebLink{

  /**
   * {@link com.google.gerrit.extensions.common.WebLinkInfo}
   * describing a link from a patch set to an external service.
   *
   * <p>In order for the web link to be visible
   * {@link com.google.gerrit.extensions.common.WebLinkInfo#url}
   * and {@link com.google.gerrit.extensions.common.WebLinkInfo#name}
   * must be set.<p>
   *
   * @param projectName Name of the project
   * @param commit Commit of the patch set
   * @return WebLinkInfo that links to patch set in external service,
   * null if there should be no link.
   */
  WebLinkInfo getPathSetWebLink(final String projectName, final String commit);
}