001/* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2013 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@Retention(RetentionPolicy.RUNTIME) 028@Target(ElementType.TYPE) 029public @interface WidgetProperty { 030 031 String key(); 032 033 WidgetPropertyType type() default WidgetPropertyType.STRING; 034 035 String defaultValue() default ""; 036 037 String description() default ""; 038 039 boolean optional() default true; 040 041 /** 042 * @since 3.3 Options for property of type WidgetPropertyType.METRIC</code>. 043 * 044 * If no option is specified, any metric will match. 045 * If options are specified, all must match for the metric to be displayed. 046 * Three types of filter are supported <code>key:REGEXP</code>, <code>domain:REGEXP</code> and <code>type:comma_separated__list_of_types</code>. 047 * For example <code>key:new_.*</code> will match any metric which key starts by <code>new_</code>. 048 * For example <code>type:INT,FLOAT</code> will match any metric of type <code>INT</code> or <code>FLOAT</code>. 049 * For example <code>type:NUMERIC</code> will match any metric of numerictype. 050 * 051 * @since 3.5 Options for property of type WidgetPropertyType.SINGLE_SELECT_LIST</code> 052 * For example {"property_1", "property_3", "property_3"}). 053 * 054 */ 055 String[] options() default {}; 056}