aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api/src/main/java/org/sonar/api/web/RubyRailsWidget.java
blob: 42f6f60c1055026f50227985cf0ef3c02a2a7c0f (plain)
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
39
40
41
42
/*
 * SonarQube
 * Copyright (C) 2009-2019 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.web;

/**
 * Widget in project dashboard page. It's recommended to also extend AbstractRubyTemplate :
 * <br>
 * <code>
 * public class MyWidget extends AbstractRubyTemplate implements RubyRailsWidget {
 * protected String getTemplatePath() {
 * return "/myplugin/my_template.erb";
 * }
 * }
 * </code>
 *
 * @since 1.11
 * @deprecated since 6.2, this extension is ignored as dashboards have been removed
 */
@Deprecated
public interface RubyRailsWidget extends Widget {
  /**
   * @return content of the Ruby on Rails template
   */
  String getTemplate();
}