org.sonar.api.web
Annotation Type WidgetProperty


@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface WidgetProperty


Required Element Summary
 String key
           
 
Optional Element Summary
 String defaultValue
           
 String description
           
 boolean optional
           
 String[] options
           
 WidgetPropertyType type
           
 

Element Detail

key

public abstract String key

type

public abstract WidgetPropertyType type
Default:
org.sonar.api.web.WidgetPropertyType.STRING

defaultValue

public abstract String defaultValue
Default:
""

description

public abstract String description
Default:
""

optional

public abstract boolean optional
Default:
true

options

public abstract String[] options
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., 3.5 Options for property of type WidgetPropertyType.SINGLE_SELECT_LIST For example {"property_1", "property_3", "property_3"}).
Default:
{}


Copyright © 2009–2015 SonarSource. All rights reserved.