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 * @deprecated since 6.2, this extension is ignored as dashboards have been removed
029 */
030@Deprecated
031@Retention(RetentionPolicy.RUNTIME)
032@Target(ElementType.TYPE)
033public @interface WidgetProperty {
034
035  String key();
036
037  WidgetPropertyType type() default WidgetPropertyType.STRING;
038
039  String defaultValue() default "";
040
041  String description() default "";
042
043  boolean optional() default true;
044
045  /**
046   * @since 3.3  Options for property of type {@link WidgetPropertyType#METRIC}.
047   *
048   * If no option is specified, any metric will match.
049   * If options are specified, all must match for the metric to be displayed.
050   * Three types of filter are supported <code>key:REGEXP</code>, <code>domain:REGEXP</code> and <code>type:comma_separated__list_of_types</code>.
051   * For example <code>key:new_.*</code> will match any metric which key starts by <code>new_</code>.
052   * For example <code>type:INT,FLOAT</code> will match any metric of type <code>INT</code> or <code>FLOAT</code>.
053   * For example <code>type:NUMERIC</code> will match any metric of numerictype.
054   *
055   * @since 3.5  Options for property of type {@link WidgetPropertyType#SINGLE_SELECT_LIST}.
056   * For example {"property_1", "property_3", "property_3"}).
057   *
058   */
059  String[] options() default {};
060}