org.sonar.api.web.WidgetProperty 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.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface WidgetProperty {

  String key();

  WidgetPropertyType type() default WidgetPropertyType.STRING;

  String defaultValue() default "";

  String description() default "";

  boolean optional() default true;

  /**
   * @since 3.3  Options for property of type WidgetPropertyType.METRIC.
   *
   * If no option is specified, any metric will match.
   * If options are specified, all must match for the metric to be displayed.
   * Three types of filter are supported key:REGEXP, domain:REGEXP and type:comma_separated__list_of_types.
   * For example key:new_.* will match any metric which key starts by new_.
   * For example type:INT,FLOAT will match any metric of type INT or FLOAT.
   * For example type:NUMERIC will match any metric of numerictype.
   *
   * @since 3.5  Options for property of type WidgetPropertyType.SINGLE_SELECT_LIST
   * For example {"property_1", "property_3", "property_3"}).
   *
   */
  String[] options() default {};
}