001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2014 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * SonarQube is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.web;
021
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * The Page is displayed only in listed sections. This annotation is ignored on Widgets.
029 * 
030 * @since 1.11
031 */
032@Retention(RetentionPolicy.RUNTIME)
033@Target(ElementType.TYPE)
034public @interface NavigationSection {
035
036  String HOME = "home";
037  String RESOURCE = "resource";
038
039  /**
040   * Support removed in 5.1. See https://jira.codehaus.org/browse/SONAR-6016.
041   * @deprecated in 4.5, as it costs too much to maintain and update.
042   * @see <a href="https://jira.codehaus.org/browse/SONAR-5321">SONAR-5321</a>
043   */
044  @Deprecated
045  String RESOURCE_TAB = "resource_tab";
046
047  String CONFIGURATION = "configuration";
048
049  /**
050   * Only Ruby and rails application. See "Extend Web Application" section of http://redirect.sonarsource.com/doc/extension-guide.html.
051   * Use the resource parameter in order to get the current resource.
052   *
053   * @since 3.6
054   */
055  String RESOURCE_CONFIGURATION = "resource_configuration";
056
057  String[] value() default { HOME };
058
059}