001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program 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 * This program 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 * @deprecated since 6.3 see {@link org.sonar.api.web.page.PageDefinition}. This class is ignored.
032 */
033@Retention(RetentionPolicy.RUNTIME)
034@Target(ElementType.TYPE)
035@Deprecated
036public @interface NavigationSection {
037
038  String HOME = "home";
039  String RESOURCE = "resource";
040
041  /**
042   * Support removed in 5.1. See https://jira.sonarsource.com/browse/SONAR-6016.
043   * @deprecated in 4.5, as it costs too much to maintain and update.
044   * @see <a href="https://jira.sonarsource.com/browse/SONAR-5321">SONAR-5321</a>
045   */
046  @Deprecated
047  String RESOURCE_TAB = "resource_tab";
048
049  String CONFIGURATION = "configuration";
050
051  /**
052   * Only Ruby and rails application. See "Extend Web Application" section of https://redirect.sonarsource.com/doc/extension-guide.html.
053   * Use the resource parameter in order to get the current resource.
054   *
055   * @since 3.6
056   */
057  String RESOURCE_CONFIGURATION = "resource_configuration";
058
059  String[] value() default { HOME };
060
061}