org.sonar.api.web.DashboardWidget Maven / Gradle / Ivy
/*
* Sonar, open source software quality management tool.
* Copyright (C) 2009 SonarSource SA
* mailto:contact AT sonarsource DOT com
*
* Sonar 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.
*
* Sonar 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 Sonar; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonar.api.web;
import org.sonar.api.ServerExtension;
/**
* Widget in project dashboard.
*
* Template is written in Ruby on Rails, so ERB snippets can be injected in HTML. Example : <%= my ruby code -%>.
* Example
*
* It's recommended to extend org.sonar.api.web.AbstractDashboardWidget
for performance reasons.
* Template is cached in memory.
*
* @since 1.10
* @deprecated use org.sonar.api.web.RubyRailsWidget, better because of optional conditions (see annotations in org.sonar.api.web.views package)
*/
@Deprecated
public interface DashboardWidget extends ServerExtension {
/**
* @return content of the Ruby on Rails template
*/
String getTemplate();
}