org.sonar.api.web.WidgetScope Maven / Gradle / Ivy

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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;

import java.lang.annotation.*;

/**
 * Depending on its scope, a widget can be available for project dashboards (value = "PROJECT"),
 * global dashboards (value = "GLOBAL") or both (value = {"PROJECT", "GLOBAL"}).
 * 
 * Before version 3.1 all widget had a scope "PROJECT". If a widget is not annotated with @WidgetScope,
 * then is is assumed project scoped.
 *
 * @since 3.1
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface WidgetScope {
  String PROJECT = "PROJECT";
  String GLOBAL = "GLOBAL";

  String[] value() default PROJECT;
}